Autogenerated HTML docs for v1.8.1-rc2-5-g252f9
diff --git a/diff-options.txt b/diff-options.txt index f4f7e25..39f2c50 100644 --- a/diff-options.txt +++ b/diff-options.txt
@@ -309,7 +309,11 @@ index (i.e. amount of addition/deletions compared to the file's size). For example, `-M90%` means git should consider a delete/add pair to be a rename if more than 90% of the file - hasn't changed. + hasn't changed. Without a `%` sign, the number is to be read as + a fraction, with a decimal point before it. I.e., `-M5` becomes + 0.5, and is thus the same as `-M50%`. Similarly, `-M05` is + the same as `-M5%`. To limit detection to exact renames, use + `-M100%`. -C[<n>]:: --find-copies[=<n>]::
diff --git a/git-diff-files.html b/git-diff-files.html index e572e9c..b82e534 100644 --- a/git-diff-files.html +++ b/git-diff-files.html
@@ -2,15 +2,25 @@ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> <head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> -<meta name="generator" content="AsciiDoc 8.5.2" /> +<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" /> +<meta name="generator" content="AsciiDoc 8.6.8" /> <title>git-diff-files(1)</title> <style type="text/css"> -/* Debug borders */ -p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 { -/* - border: 1px solid red; -*/ +/* Shared CSS for AsciiDoc xhtml11 and html5 backends */ + +/* Default font. */ +body { + font-family: Georgia,serif; +} + +/* Title font. */ +h1, h2, h3, h4, h5, h6, +div.title, caption.title, +thead, p.table.header, +#toctitle, +#author, #revnumber, #revdate, #revremark, +#footer { + font-family: Arial,Helvetica,sans-serif; } body { @@ -35,13 +45,8 @@ color: #083194; } -tt { - color: navy; -} - h1, h2, h3, h4, h5, h6 { color: #527bbd; - font-family: sans-serif; margin-top: 1.2em; margin-bottom: 0.5em; line-height: 1.3; @@ -59,9 +64,11 @@ h3 + * { clear: left; } +h5 { + font-size: 1.0em; +} div.sectionbody { - font-family: serif; margin-left: 0; } @@ -77,45 +84,48 @@ ul, ol, li > p { margin-top: 0; } +ul > li { color: #aaa; } +ul > li > * { color: black; } -pre { +.monospaced, code, pre { + font-family: "Courier New", Courier, monospace; + font-size: inherit; + color: navy; padding: 0; margin: 0; } -span#author { + +#author { color: #527bbd; - font-family: sans-serif; font-weight: bold; font-size: 1.1em; } -span#email { +#email { } -span#revnumber, span#revdate, span#revremark { - font-family: sans-serif; +#revnumber, #revdate, #revremark { } -div#footer { - font-family: sans-serif; +#footer { font-size: small; border-top: 2px solid silver; padding-top: 0.5em; margin-top: 4.0em; } -div#footer-text { +#footer-text { float: left; padding-bottom: 0.5em; } -div#footer-badges { +#footer-badges { float: right; padding-bottom: 0.5em; } -div#preamble { +#preamble { margin-top: 1.5em; margin-bottom: 1.5em; } -div.tableblock, div.imageblock, div.exampleblock, div.verseblock, +div.imageblock, div.exampleblock, div.verseblock, div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock, div.admonitionblock { margin-top: 1.0em; @@ -135,7 +145,6 @@ /* Block element titles. */ div.title, caption.title { color: #527bbd; - font-family: sans-serif; font-weight: bold; text-align: left; margin-top: 1.0em; @@ -157,13 +166,15 @@ div.sidebarblock > div.content { background: #ffffee; - border: 1px solid silver; + border: 1px solid #dddddd; + border-left: 4px solid #f0f0f0; padding: 0.5em; } div.listingblock > div.content { - border: 1px solid silver; - background: #f4f4f4; + border: 1px solid #dddddd; + border-left: 5px solid #f0f0f0; + background: #f8f8f8; padding: 0.5em; } @@ -171,8 +182,8 @@ padding-left: 1.0em; margin-left: 1.0em; margin-right: 10%; - border-left: 5px solid #dddddd; - color: #777777; + border-left: 5px solid #f0f0f0; + color: #888; } div.quoteblock > div.attribution { @@ -180,8 +191,9 @@ text-align: right; } -div.verseblock > div.content { - white-space: pre; +div.verseblock > pre.content { + font-family: inherit; + font-size: inherit; } div.verseblock > div.attribution { padding-top: 0.75em; @@ -254,35 +266,12 @@ margin-bottom: 0.1em; } -div.tableblock > table { - border: 3px solid #527bbd; -} -thead, p.table.header { - font-family: sans-serif; - font-weight: bold; -} tfoot { font-weight: bold; } td > div.verse { white-space: pre; } -p.table { - margin-top: 0; -} -/* Because the table frame attribute is overriden by CSS in most browsers. */ -div.tableblock > table[frame="void"] { - border-style: none; -} -div.tableblock > table[frame="hsides"] { - border-left-style: none; - border-right-style: none; -} -div.tableblock > table[frame="vsides"] { - border-top-style: none; - border-bottom-style: none; -} - div.hdlist { margin-top: 0.8em; @@ -339,25 +328,32 @@ min-width: 100px; } - -@media print { - div#footer-badges { display: none; } +div.colist td { + padding-right: 0.5em; + padding-bottom: 0.3em; + vertical-align: top; +} +div.colist td img { + margin-top: 0.3em; } -div#toc { +@media print { + #footer-badges { display: none; } +} + +#toc { margin-bottom: 2.5em; } -div#toctitle { +#toctitle { color: #527bbd; - font-family: sans-serif; font-size: 1.1em; font-weight: bold; margin-top: 1.0em; margin-bottom: 0.1em; } -div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 { +div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 { margin-top: 0; margin-bottom: 0; } @@ -373,69 +369,173 @@ margin-left: 6em; font-size: 0.9em; } -/* Overrides for manpage documents */ -h1 { + +span.aqua { color: aqua; } +span.black { color: black; } +span.blue { color: blue; } +span.fuchsia { color: fuchsia; } +span.gray { color: gray; } +span.green { color: green; } +span.lime { color: lime; } +span.maroon { color: maroon; } +span.navy { color: navy; } +span.olive { color: olive; } +span.purple { color: purple; } +span.red { color: red; } +span.silver { color: silver; } +span.teal { color: teal; } +span.white { color: white; } +span.yellow { color: yellow; } + +span.aqua-background { background: aqua; } +span.black-background { background: black; } +span.blue-background { background: blue; } +span.fuchsia-background { background: fuchsia; } +span.gray-background { background: gray; } +span.green-background { background: green; } +span.lime-background { background: lime; } +span.maroon-background { background: maroon; } +span.navy-background { background: navy; } +span.olive-background { background: olive; } +span.purple-background { background: purple; } +span.red-background { background: red; } +span.silver-background { background: silver; } +span.teal-background { background: teal; } +span.white-background { background: white; } +span.yellow-background { background: yellow; } + +span.big { font-size: 2em; } +span.small { font-size: 0.6em; } + +span.underline { text-decoration: underline; } +span.overline { text-decoration: overline; } +span.line-through { text-decoration: line-through; } + +div.unbreakable { page-break-inside: avoid; } + + +/* + * xhtml11 specific + * + * */ + +div.tableblock { + margin-top: 1.0em; + margin-bottom: 1.5em; +} +div.tableblock > table { + border: 3px solid #527bbd; +} +thead, p.table.header { + font-weight: bold; + color: #527bbd; +} +p.table { + margin-top: 0; +} +/* Because the table frame attribute is overriden by CSS in most browsers. */ +div.tableblock > table[frame="void"] { + border-style: none; +} +div.tableblock > table[frame="hsides"] { + border-left-style: none; + border-right-style: none; +} +div.tableblock > table[frame="vsides"] { + border-top-style: none; + border-bottom-style: none; +} + + +/* + * html5 specific + * + * */ + +table.tableblock { + margin-top: 1.0em; + margin-bottom: 1.5em; +} +thead, p.tableblock.header { + font-weight: bold; + color: #527bbd; +} +p.tableblock { + margin-top: 0; +} +table.tableblock { + border-width: 3px; + border-spacing: 0px; + border-style: solid; + border-color: #527bbd; + border-collapse: collapse; +} +th.tableblock, td.tableblock { + border-width: 1px; + padding: 4px; + border-style: solid; + border-color: #527bbd; +} + +table.tableblock.frame-topbot { + border-left-style: hidden; + border-right-style: hidden; +} +table.tableblock.frame-sides { + border-top-style: hidden; + border-bottom-style: hidden; +} +table.tableblock.frame-none { + border-style: hidden; +} + +th.tableblock.halign-left, td.tableblock.halign-left { + text-align: left; +} +th.tableblock.halign-center, td.tableblock.halign-center { + text-align: center; +} +th.tableblock.halign-right, td.tableblock.halign-right { + text-align: right; +} + +th.tableblock.valign-top, td.tableblock.valign-top { + vertical-align: top; +} +th.tableblock.valign-middle, td.tableblock.valign-middle { + vertical-align: middle; +} +th.tableblock.valign-bottom, td.tableblock.valign-bottom { + vertical-align: bottom; +} + + +/* + * manpage specific + * + * */ + +body.manpage h1 { padding-top: 0.5em; padding-bottom: 0.5em; border-top: 2px solid silver; border-bottom: 2px solid silver; } -h2 { +body.manpage h2 { border-style: none; } -div.sectionbody { - margin-left: 5%; +body.manpage div.sectionbody { + margin-left: 3em; } @media print { - div#toc { display: none; } + body.manpage div#toc { display: none; } } -/* Workarounds for IE6's broken and incomplete CSS2. */ -div.sidebar-content { - background: #ffffee; - border: 1px solid silver; - padding: 0.5em; -} -div.sidebar-title, div.image-title { - color: #527bbd; - font-family: sans-serif; - font-weight: bold; - margin-top: 0.0em; - margin-bottom: 0.5em; -} - -div.listingblock div.content { - border: 1px solid silver; - background: #f4f4f4; - padding: 0.5em; -} - -div.quoteblock-attribution { - padding-top: 0.5em; - text-align: right; -} - -div.verseblock-content { - white-space: pre; -} -div.verseblock-attribution { - padding-top: 0.75em; - text-align: left; -} - -div.exampleblock-content { - border-left: 3px solid #dddddd; - padding-left: 0.5em; -} - -/* IE6 sets dynamically generated links as visited. */ -div#toc a:visited { color: blue; } </style> <script type="text/javascript"> /*<+'])'); + var re = new RegExp('[hH]([1-'+(toclevels+1)+'])'); // Function that scans the DOM tree for header elements (the DOM2 // nodeIterator API would be a better technique but not supported by all // browsers). @@ -497,6 +597,25 @@ } var toc = document.getElementById("toc"); + if (!toc) { + return; + } + + // Delete existing TOC entries in case we're reloading the TOC. + var tocEntriesToRemove = []; + var i; + for (i = 0; i < toc.childNodes.length; i++) { + var entry = toc.childNodes[i]; + if (entry.nodeName.toLowerCase() == 'div' + && entry.getAttribute("class") + && entry.getAttribute("class").match(/^toclevel/)) + tocEntriesToRemove.push(entry); + } + for (i = 0; i < tocEntriesToRemove.length; i++) { + toc.removeChild(tocEntriesToRemove[i]); + } + + // Rebuild TOC entries. var entries = tocEntries(document.getElementById("content"), toclevels); for (var i = 0; i < entries.length; ++i) { var entry = entries[i]; @@ -524,24 +643,44 @@ */ footnotes: function () { - var cont = document.getElementById("content"); + // Delete existing footnote entries in case we're reloading the footnodes. + var i; var noteholder = document.getElementById("footnotes"); + if (!noteholder) { + return; + } + var entriesToRemove = []; + for (i = 0; i < noteholder.childNodes.length; i++) { + var entry = noteholder.childNodes[i]; + if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote") + entriesToRemove.push(entry); + } + for (i = 0; i < entriesToRemove.length; i++) { + noteholder.removeChild(entriesToRemove[i]); + } + + // Rebuild footnote entries. + var cont = document.getElementById("content"); var spans = cont.getElementsByTagName("span"); var refs = {}; var n = 0; for (i=0; i<spans.length; i++) { if (spans[i].className == "footnote") { n++; - // Use [\s\S] in place of . so multi-line matches work. - // Because JavaScript has no s (dotall) regex flag. - note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1]; + var note = spans[i].getAttribute("data-note"); + if (!note) { + // Use [\s\S] in place of . so multi-line matches work. + // Because JavaScript has no s (dotall) regex flag. + note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1]; + spans[i].innerHTML = + "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n + + "' title='View footnote' class='footnote'>" + n + "</a>]"; + spans[i].setAttribute("data-note", note); + } noteholder.innerHTML += "<div class='footnote' id='_footnote_" + n + "'>" + "<a href='#_footnoteref_" + n + "' title='Return to text'>" + n + "</a>. " + note + "</div>"; - spans[i].innerHTML = - "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n + - "' title='View footnote' class='footnote'>" + n + "</a>]"; var id =spans[i].getAttribute("id"); if (id != null) refs["#"+id] = n; } @@ -561,13 +700,36 @@ } } } +}, + +install: function(toclevels) { + var timerId; + + function reinstall() { + asciidoc.footnotes(); + if (toclevels) { + asciidoc.toc(toclevels); + } + } + + function reinstallAndRemoveTimer() { + clearInterval(timerId); + reinstall(); + } + + timerId = setInterval(reinstall, 500); + if (document.addEventListener) + document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false); + else + window.onload = reinstallAndRemoveTimer; } } +asciidoc.install(); /*]]>*/ </script> </head> -<body> +<body class="manpage"> <div id="header"> <h1> git-diff-files(1) Manual Page @@ -580,13 +742,16 @@ </div> </div> <div id="content"> +<div class="sect1"> <h2 id="_synopsis">SYNOPSIS</h2> <div class="sectionbody"> <div class="verseblock"> -<div class="verseblock-content"><em>git diff-files</em> [-q] [-0|-1|-2|-3|-c|--cc] [<common diff options>] [<path>…]</div> -<div class="verseblock-attribution"> +<pre class="content"><em>git diff-files</em> [-q] [-0|-1|-2|-3|-c|--cc] [<common diff options>] [<path>…]</pre> +<div class="attribution"> </div></div> </div> +</div> +<div class="sect1"> <h2 id="_description">DESCRIPTION</h2> <div class="sectionbody"> <div class="paragraph"><p>Compares the files in the working tree and the index. When paths @@ -594,6 +759,8 @@ entries in the index are compared. The output format is the same as for <em>git diff-index</em> and <em>git diff-tree</em>.</p></div> </div> +</div> +<div class="sect1"> <h2 id="_options">OPTIONS</h2> <div class="sectionbody"> <div class="dlist"><dl> @@ -622,7 +789,7 @@ <p> Generate diffs with <n> lines of context instead of the usual three. - Implies <tt>-p</tt>. + Implies <code>-p</code>. </p> </dd> <dt class="hdlist1"> @@ -639,7 +806,7 @@ </dt> <dd> <p> - Synonym for <tt>-p --raw</tt>. + Synonym for <code>-p --raw</code>. </p> </dd> <dt class="hdlist1"> @@ -676,29 +843,29 @@ will be used for the filename part, and the rest for the graph part. Maximum width defaults to terminal width, or 80 columns if not connected to a terminal, and can be overridden by - <tt><width></tt>. The width of the filename part can be limited by - giving another width <tt><name-width></tt> after a comma. The width + <code><width></code>. The width of the filename part can be limited by + giving another width <code><name-width></code> after a comma. The width of the graph part can be limited by using - <tt>--stat-graph-width=<width></tt> (affects all commands generating - a stat graph) or by setting <tt>diff.statGraphWidth=<width></tt> - (does not affect <tt>git format-patch</tt>). - By giving a third parameter <tt><count></tt>, you can limit the - output to the first <tt><count></tt> lines, followed by <tt>...</tt> if + <code>--stat-graph-width=<width></code> (affects all commands generating + a stat graph) or by setting <code>diff.statGraphWidth=<width></code> + (does not affect <code>git format-patch</code>). + By giving a third parameter <code><count></code>, you can limit the + output to the first <code><count></code> lines, followed by <code>...</code> if there are more. </p> -<div class="paragraph"><p>These parameters can also be set individually with <tt>--stat-width=<width></tt>, -<tt>--stat-name-width=<name-width></tt> and <tt>--stat-count=<count></tt>.</p></div> +<div class="paragraph"><p>These parameters can also be set individually with <code>--stat-width=<width></code>, +<code>--stat-name-width=<name-width></code> and <code>--stat-count=<count></code>.</p></div> </dd> <dt class="hdlist1"> --numstat </dt> <dd> <p> - Similar to <tt>--stat</tt>, but shows number of added and + Similar to <code>--stat</code>, but shows number of added and deleted lines in decimal notation and pathname without abbreviation, to make it more machine friendly. For - binary files, outputs two <tt>-</tt> instead of saying - <tt>0 0</tt>. + binary files, outputs two <code>-</code> instead of saying + <code>0 0</code>. </p> </dd> <dt class="hdlist1"> @@ -706,7 +873,7 @@ </dt> <dd> <p> - Output only the last line of the <tt>--stat</tt> format containing total + Output only the last line of the <code>--stat</code> format containing total number of modified files, as well as number of added and deleted lines. </p> @@ -717,15 +884,17 @@ <dd> <p> Output the distribution of relative amount of changes for each - sub-directory. The behavior of <tt>--dirstat</tt> can be customized by + sub-directory. The behavior of <code>--dirstat</code> can be customized by passing it a comma separated list of parameters. - The defaults are controlled by the <tt>diff.dirstat</tt> configuration + The defaults are controlled by the <code>diff.dirstat</code> configuration variable (see <a href="git-config.html">git-config(1)</a>). The following parameters are available: </p> +<div class="openblock"> +<div class="content"> <div class="dlist"><dl> <dt class="hdlist1"> -<tt>changes</tt> +<code>changes</code> </dt> <dd> <p> @@ -737,39 +906,39 @@ </p> </dd> <dt class="hdlist1"> -<tt>lines</tt> +<code>lines</code> </dt> <dd> <p> Compute the dirstat numbers by doing the regular line-based diff analysis, and summing the removed/added line counts. (For binary files, count 64-byte chunks instead, since binary files have no - natural concept of lines). This is a more expensive <tt>--dirstat</tt> - behavior than the <tt>changes</tt> behavior, but it does count rearranged + natural concept of lines). This is a more expensive <code>--dirstat</code> + behavior than the <code>changes</code> behavior, but it does count rearranged lines within a file as much as other changes. The resulting output - is consistent with what you get from the other <tt>--*stat</tt> options. + is consistent with what you get from the other <code>--*stat</code> options. </p> </dd> <dt class="hdlist1"> -<tt>files</tt> +<code>files</code> </dt> <dd> <p> Compute the dirstat numbers by counting the number of files changed. Each changed file counts equally in the dirstat analysis. This is - the computationally cheapest <tt>--dirstat</tt> behavior, since it does + the computationally cheapest <code>--dirstat</code> behavior, since it does not have to look at the file contents at all. </p> </dd> <dt class="hdlist1"> -<tt>cumulative</tt> +<code>cumulative</code> </dt> <dd> <p> Count changes in a child directory for the parent directory as well. - Note that when using <tt>cumulative</tt>, the sum of the percentages + Note that when using <code>cumulative</code>, the sum of the percentages reported may exceed 100%. The default (non-cumulative) behavior can - be specified with the <tt>noncumulative</tt> parameter. + be specified with the <code>noncumulative</code> parameter. </p> </dd> <dt class="hdlist1"> @@ -783,10 +952,11 @@ </p> </dd> </dl></div> +</div></div> <div class="paragraph"><p>Example: The following will count changed files, while ignoring directories with less than 10% of the total amount of changed files, and accumulating child directory counts in the parent directories: -<tt>--dirstat=files,10,cumulative</tt>.</p></div> +<code>--dirstat=files,10,cumulative</code>.</p></div> </dd> <dt class="hdlist1"> --summary @@ -802,7 +972,7 @@ </dt> <dd> <p> - Synonym for <tt>-p --stat</tt>. + Synonym for <code>-p --stat</code>. </p> </dd> <dt class="hdlist1"> @@ -810,11 +980,11 @@ </dt> <dd> <p> - When <tt>--raw</tt>, <tt>--numstat</tt>, <tt>--name-only</tt> or <tt>--name-status</tt> has been + When <code>--raw</code>, <code>--numstat</code>, <code>--name-only</code> or <code>--name-status</code> has been given, do not munge pathnames and use NULs as output field terminators. </p> <div class="paragraph"><p>Without this option, each pathname output will have TAB, LF, double quotes, -and backslash characters replaced with <tt>\t</tt>, <tt>\n</tt>, <tt>\"</tt>, and <tt>\\</tt>, +and backslash characters replaced with <code>\t</code>, <code>\n</code>, <code>\"</code>, and <code>\\</code>, respectively, and the pathname will be enclosed in double quotes if any of those replacements occurred.</p></div> </dd> @@ -832,7 +1002,7 @@ <dd> <p> Show only names and status of changed files. See the description - of the <tt>--diff-filter</tt> option on what the status letters mean. + of the <code>--diff-filter</code> option on what the status letters mean. </p> </dd> <dt class="hdlist1"> @@ -840,13 +1010,13 @@ </dt> <dd> <p> - Specify how differences in submodules are shown. When <tt>--submodule</tt> - or <tt>--submodule=log</tt> is given, the <em>log</em> format is used. This format lists - the commits in the range like <a href="git-submodule.html">git-submodule(1)</a> <tt>summary</tt> does. - Omitting the <tt>--submodule</tt> option or specifying <tt>--submodule=short</tt>, + Specify how differences in submodules are shown. When <code>--submodule</code> + or <code>--submodule=log</code> is given, the <em>log</em> format is used. This format lists + the commits in the range like <a href="git-submodule.html">git-submodule(1)</a> <code>summary</code> does. + Omitting the <code>--submodule</code> option or specifying <code>--submodule=short</code>, uses the <em>short</em> format. This format just shows the names of the commits at the beginning and end of the range. Can be tweaked via the - <tt>diff.submodule</tt> configuration variable. + <code>diff.submodule</code> configuration variable. </p> </dd> <dt class="hdlist1"> @@ -855,8 +1025,8 @@ <dd> <p> Show colored diff. - The value must be <tt>always</tt> (the default for <tt><when></tt>), <tt>never</tt>, or <tt>auto</tt>. - The default value is <tt>never</tt>. + The value must be <code>always</code> (the default for <code><when></code>), <code>never</code>, or <code>auto</code>. + The default value is <code>never</code>. </p> </dd> <dt class="hdlist1"> @@ -865,7 +1035,7 @@ <dd> <p> Turn off colored diff. - It is the same as <tt>--color=never</tt>. + It is the same as <code>--color=never</code>. </p> </dd> <dt class="hdlist1"> @@ -875,16 +1045,18 @@ <p> Show a word diff, using the <mode> to delimit changed words. By default, words are delimited by whitespace; see - <tt>--word-diff-regex</tt> below. The <mode> defaults to <em>plain</em>, and + <code>--word-diff-regex</code> below. The <mode> defaults to <em>plain</em>, and must be one of: </p> +<div class="openblock"> +<div class="content"> <div class="dlist"><dl> <dt class="hdlist1"> color </dt> <dd> <p> - Highlight changed words using only colors. Implies <tt>--color</tt>. + Highlight changed words using only colors. Implies <code>--color</code>. </p> </dd> <dt class="hdlist1"> @@ -892,7 +1064,7 @@ </dt> <dd> <p> - Show words as <tt>[-removed-]</tt> and <tt>{+added+}</tt>. Makes no + Show words as <code>[-removed-]</code> and <code>{+added+}</code>. Makes no attempts to escape the delimiters if they appear in the input, so the output may be ambiguous. </p> @@ -904,10 +1076,10 @@ <p> Use a special line-based format intended for script consumption. Added/removed/unchanged runs are printed in the - usual unified diff format, starting with a <tt>+</tt>/<tt>-</tt>/` ` + usual unified diff format, starting with a <code>+</code>/<code>-</code>/` ` character at the beginning of the line and extending to the end of the line. Newlines in the input are represented by a - tilde <tt>~</tt> on a line of its own. + tilde <code>~</code> on a line of its own. </p> </dd> <dt class="hdlist1"> @@ -919,6 +1091,7 @@ </p> </dd> </dl></div> +</div></div> <div class="paragraph"><p>Note that despite the name of the first mode, color is used to highlight the changed parts in all modes if enabled.</p></div> </dd> @@ -929,12 +1102,12 @@ <p> Use <regex> to decide what a word is, instead of considering runs of non-whitespace to be a word. Also implies - <tt>--word-diff</tt> unless it was already enabled. + <code>--word-diff</code> unless it was already enabled. </p> <div class="paragraph"><p>Every non-overlapping match of the <regex> is considered a word. Anything between these matches is considered whitespace and ignored(!) for the purposes of finding -differences. You may want to append <tt>|[^[:space:]]</tt> to your regular +differences. You may want to append <code>|[^[:space:]]</code> to your regular expression to make sure that it matches all non-whitespace characters. A match that contains a newline is silently truncated(!) at the newline.</p></div> @@ -948,8 +1121,8 @@ </dt> <dd> <p> - Equivalent to <tt>--word-diff=color</tt> plus (if a regex was - specified) <tt>--word-diff-regex=<regex></tt>. + Equivalent to <code>--word-diff=color</code> plus (if a regex was + specified) <code>--word-diff-regex=<regex></code>. </p> </dd> <dt class="hdlist1"> @@ -967,7 +1140,7 @@ <dd> <p> Warn if changes introduce whitespace errors. What are - considered whitespace errors is controlled by <tt>core.whitespace</tt> + considered whitespace errors is controlled by <code>core.whitespace</code> configuration. By default, trailing whitespaces (including lines that solely consist of whitespaces) and a space character that is immediately followed by a tab character inside the @@ -991,8 +1164,8 @@ </dt> <dd> <p> - In addition to <tt>--full-index</tt>, output a binary diff that - can be applied with <tt>git-apply</tt>. + In addition to <code>--full-index</code>, output a binary diff that + can be applied with <code>git-apply</code>. </p> </dd> <dt class="hdlist1"> @@ -1003,9 +1176,9 @@ Instead of showing the full 40-byte hexadecimal object name in diff-raw format output and diff-tree header lines, show only a partial prefix. This is - independent of the <tt>--full-index</tt> option above, which controls + independent of the <code>--full-index</code> option above, which controls the diff-patch output format. Non default number of - digits can be specified with <tt>--abbrev=<n></tt>. + digits can be specified with <code>--abbrev=<n></code>. </p> </dd> <dt class="hdlist1"> @@ -1023,15 +1196,15 @@ not as a series of deletion and insertion mixed together with a very few lines that happen to match textually as the context, but as a single deletion of everything old followed by a single insertion of -everything new, and the number <tt>m</tt> controls this aspect of the -B -option (defaults to 60%). <tt>-B/70%</tt> specifies that less than 30% of the +everything new, and the number <code>m</code> controls this aspect of the -B +option (defaults to 60%). <code>-B/70%</code> specifies that less than 30% of the original should remain in the result for git to consider it a total rewrite (i.e. otherwise the resulting patch will be a series of deletion and insertion mixed together with context lines).</p></div> <div class="paragraph"><p>When used with -M, a totally-rewritten file is also considered as the source of a rename (usually -M only considers a file that disappeared -as the source of a rename), and the number <tt>n</tt> controls this aspect of -the -B option (defaults to 50%). <tt>-B20%</tt> specifies that a change with +as the source of a rename), and the number <code>n</code> controls this aspect of +the -B option (defaults to 50%). <code>-B20%</code> specifies that a change with addition and deletion compared to 20% or more of the file’s size are eligible for being picked up as a possible source of a rename to another file.</p></div> @@ -1045,11 +1218,15 @@ <dd> <p> Detect renames. - If <tt>n</tt> is specified, it is a threshold on the similarity + If <code>n</code> is specified, it is a threshold on the similarity index (i.e. amount of addition/deletions compared to the - file’s size). For example, <tt>-M90%</tt> means git should consider a + file’s size). For example, <code>-M90%</code> means git should consider a delete/add pair to be a rename if more than 90% of the file - hasn’t changed. + hasn’t changed. Without a <code>%</code> sign, the number is to be read as + a fraction, with a decimal point before it. I.e., <code>-M5</code> becomes + 0.5, and is thus the same as <code>-M50%</code>. Similarly, <code>-M05</code> is + the same as <code>-M5%</code>. To limit detection to exact renames, use + <code>-M100%</code>. </p> </dd> <dt class="hdlist1"> @@ -1060,8 +1237,8 @@ </dt> <dd> <p> - Detect copies as well as renames. See also <tt>--find-copies-harder</tt>. - If <tt>n</tt> is specified, it has the same meaning as for <tt>-M<n></tt>. + Detect copies as well as renames. See also <code>--find-copies-harder</code>. + If <code>n</code> is specified, it has the same meaning as for <code>-M<n></code>. </p> </dd> <dt class="hdlist1"> @@ -1069,13 +1246,13 @@ </dt> <dd> <p> - For performance reasons, by default, <tt>-C</tt> option finds copies only + For performance reasons, by default, <code>-C</code> option finds copies only if the original file of the copy was modified in the same changeset. This flag makes the command inspect unmodified files as candidates for the source of copy. This is a very expensive operation for large projects, so use it with caution. Giving more than one - <tt>-C</tt> option has the same effect. + <code>-C</code> option has the same effect. </p> </dd> <dt class="hdlist1"> @@ -1087,14 +1264,14 @@ <dd> <p> Omit the preimage for deletes, i.e. print only the header but not - the diff between the preimage and <tt>/dev/null</tt>. The resulting patch - is not meant to be applied with <tt>patch</tt> nor <tt>git apply</tt>; this is + the diff between the preimage and <code>/dev/null</code>. The resulting patch + is not meant to be applied with <code>patch</code> nor <code>git apply</code>; this is solely for people who want to just concentrate on reviewing the text after the change. In addition, the output obviously lack enough information to apply such a patch in reverse, even manually, hence the name of the option. </p> -<div class="paragraph"><p>When used together with <tt>-B</tt>, omit also the preimage in the deletion part +<div class="paragraph"><p>When used together with <code>-B</code>, omit also the preimage in the deletion part of a delete/create pair.</p></div> </dd> <dt class="hdlist1"> @@ -1102,7 +1279,7 @@ </dt> <dd> <p> - The <tt>-M</tt> and <tt>-C</tt> options require O(n^2) processing time where n + The <code>-M</code> and <code>-C</code> options require O(n^2) processing time where n is the number of potential rename/copy targets. This option prevents rename/copy detection from running if the number of rename/copy targets exceeds the specified @@ -1114,13 +1291,13 @@ </dt> <dd> <p> - Select only files that are Added (<tt>A</tt>), Copied (<tt>C</tt>), - Deleted (<tt>D</tt>), Modified (<tt>M</tt>), Renamed (<tt>R</tt>), have their - type (i.e. regular file, symlink, submodule, …) changed (<tt>T</tt>), - are Unmerged (<tt>U</tt>), are - Unknown (<tt>X</tt>), or have had their pairing Broken (<tt>B</tt>). + Select only files that are Added (<code>A</code>), Copied (<code>C</code>), + Deleted (<code>D</code>), Modified (<code>M</code>), Renamed (<code>R</code>), have their + type (i.e. regular file, symlink, submodule, …) changed (<code>T</code>), + are Unmerged (<code>U</code>), are + Unknown (<code>X</code>), or have had their pairing Broken (<code>B</code>). Any combination of the filter characters (including none) can be used. - When <tt>*</tt> (All-or-none) is added to the combination, all + When <code>*</code> (All-or-none) is added to the combination, all paths are selected if there is any file that matches other criteria in the comparison; if there is no file that matches other criteria, nothing is selected. @@ -1151,7 +1328,7 @@ </dt> <dd> <p> - When <tt>-S</tt> or <tt>-G</tt> finds a change, show all the changes in that + When <code>-S</code> or <code>-G</code> finds a change, show all the changes in that changeset, not just the files that contain the change in <string>. </p> @@ -1276,7 +1453,7 @@ </dt> <dd> <p> - Disable all output of the program. Implies <tt>--exit-code</tt>. + Disable all output of the program. Implies <code>--exit-code</code>. </p> </dd> <dt class="hdlist1"> @@ -1407,6 +1584,8 @@ </dd> </dl></div> </div> +</div> +<div class="sect1"> <h2 id="_raw_output_format">Raw output format</h2> <div class="sectionbody"> <div class="paragraph"><p>The raw output format from "git-diff-index", "git-diff-tree", @@ -1453,12 +1632,12 @@ <div class="paragraph"><p>An output line is formatted this way:</p></div> <div class="listingblock"> <div class="content"> -<pre><tt>in-place edit :100644 100644 bcd1234... 0123456... M file0 +<pre><code>in-place edit :100644 100644 bcd1234... 0123456... M file0 copy-edit :100644 100644 abcd123... 1234567... C68 file1 file2 rename-edit :100644 100644 abcd123... 1234567... R86 file1 file3 create :000000 100644 0000000... 1234567... A file4 delete :100644 000000 1234567... 0000000... D file5 -unmerged :000000 000000 0000000... 0000000... U file6</tt></pre> +unmerged :000000 000000 0000000... 0000000... U file6</code></pre> </div></div> <div class="paragraph"><p>That is, from the left to the right:</p></div> <div class="olist arabic"><ol class="arabic"> @@ -1590,12 +1769,14 @@ <div class="paragraph"><p>Example:</p></div> <div class="listingblock"> <div class="content"> -<pre><tt>:100644 100644 5be4a4...... 000000...... M file.c</tt></pre> +<pre><code>:100644 100644 5be4a4...... 000000...... M file.c</code></pre> </div></div> -<div class="paragraph"><p>When <tt>-z</tt> option is not used, TAB, LF, and backslash characters -in pathnames are represented as <tt>\t</tt>, <tt>\n</tt>, and <tt>\\</tt>, +<div class="paragraph"><p>When <code>-z</code> option is not used, TAB, LF, and backslash characters +in pathnames are represented as <code>\t</code>, <code>\n</code>, and <code>\\</code>, respectively.</p></div> </div> +</div> +<div class="sect1"> <h2 id="_diff_format_for_merges">diff format for merges</h2> <div class="sectionbody"> <div class="paragraph"><p>"git-diff-tree", "git-diff-files" and "git-diff --raw" @@ -1632,11 +1813,13 @@ <div class="paragraph"><p>Example:</p></div> <div class="listingblock"> <div class="content"> -<pre><tt>::100644 100644 100644 fabadb8... cc95eb0... 4866510... MM describe.c</tt></pre> +<pre><code>::100644 100644 100644 fabadb8... cc95eb0... 4866510... MM describe.c</code></pre> </div></div> <div class="paragraph"><p>Note that <em>combined diff</em> lists only files which were modified from all parents.</p></div> </div> +</div> +<div class="sect1"> <h2 id="_generating_patches_with_p">Generating patches with -p</h2> <div class="sectionbody"> <div class="paragraph"><p>When "git-diff-index", "git-diff-tree", or "git-diff-files" are run @@ -1654,12 +1837,12 @@ </p> <div class="literalblock"> <div class="content"> -<pre><tt>diff --git a/file1 b/file2</tt></pre> +<pre><code>diff --git a/file1 b/file2</code></pre> </div></div> -<div class="paragraph"><p>The <tt>a/</tt> and <tt>b/</tt> filenames are the same unless rename/copy is +<div class="paragraph"><p>The <code>a/</code> and <code>b/</code> filenames are the same unless rename/copy is involved. Especially, even for a creation or a deletion, -<tt>/dev/null</tt> is <em>not</em> used in place of the <tt>a/</tt> or <tt>b/</tt> filenames.</p></div> -<div class="paragraph"><p>When rename/copy is involved, <tt>file1</tt> and <tt>file2</tt> show the +<code>/dev/null</code> is <em>not</em> used in place of the <code>a/</code> or <code>b/</code> filenames.</p></div> +<div class="paragraph"><p>When rename/copy is involved, <code>file1</code> and <code>file2</code> show the name of the source file of the rename/copy and the name of the file that rename/copy produces, respectively.</p></div> </li> @@ -1669,7 +1852,7 @@ </p> <div class="literalblock"> <div class="content"> -<pre><tt>old mode <mode> +<pre><code>old mode <mode> new mode <mode> deleted file mode <mode> new file mode <mode> @@ -1679,11 +1862,11 @@ rename to <path> similarity index <number> dissimilarity index <number> -index <hash>..<hash> <mode></tt></pre> +index <hash>..<hash> <mode></code></pre> </div></div> <div class="paragraph"><p>File modes are printed as 6-digit octal numbers including the file type and file permission bits.</p></div> -<div class="paragraph"><p>Path names in extended headers do not include the <tt>a/</tt> and <tt>b/</tt> prefixes.</p></div> +<div class="paragraph"><p>Path names in extended headers do not include the <code>a/</code> and <code>b/</code> prefixes.</p></div> <div class="paragraph"><p>The similarity index is the percentage of unchanged lines, and the dissimilarity index is the percentage of changed lines. It is a rounded down integer, followed by a percent sign. The @@ -1697,33 +1880,35 @@ <li> <p> TAB, LF, double quote and backslash characters in pathnames - are represented as <tt>\t</tt>, <tt>\n</tt>, <tt>\"</tt> and <tt>\\</tt>, respectively. + are represented as <code>\t</code>, <code>\n</code>, <code>\"</code> and <code>\\</code>, respectively. If there is need for such substitution then the whole pathname is put in double quotes. </p> </li> <li> <p> -All the <tt>file1</tt> files in the output refer to files before the - commit, and all the <tt>file2</tt> files refer to files after the commit. +All the <code>file1</code> files in the output refer to files before the + commit, and all the <code>file2</code> files refer to files after the commit. It is incorrect to apply each change to each file sequentially. For example, this patch will swap a and b: </p> <div class="literalblock"> <div class="content"> -<pre><tt>diff --git a/a b/b +<pre><code>diff --git a/a b/b rename from a rename to b diff --git a/b b/a rename from b -rename to a</tt></pre> +rename to a</code></pre> </div></div> </li> </ol></div> </div> +</div> +<div class="sect1"> <h2 id="_combined_diff_format">combined diff format</h2> <div class="sectionbody"> -<div class="paragraph"><p>Any diff-generating command can take the ‘-c` or <tt>--cc</tt> option to +<div class="paragraph"><p>Any diff-generating command can take the ‘-c` or <code>--cc</code> option to produce a <em>combined diff</em> when showing a merge. This is the default format when showing merges with <a href="git-diff.html">git-diff(1)</a> or <a href="git-show.html">git-show(1)</a>. Note also that you can give the `-m’ option to any @@ -1732,7 +1917,7 @@ <div class="paragraph"><p>A <em>combined diff</em> format looks like this:</p></div> <div class="listingblock"> <div class="content"> -<pre><tt>diff --combined describe.c +<pre><code>diff --combined describe.c index fabadb8,cc95eb0..4866510 --- a/describe.c +++ b/describe.c @@ -1758,7 +1943,7 @@ + if (!initialized) { initialized = 1; - for_each_ref(get_name);</tt></pre> + for_each_ref(get_name);</code></pre> </div></div> <div class="olist arabic"><ol class="arabic"> <li> @@ -1768,12 +1953,12 @@ </p> <div class="literalblock"> <div class="content"> -<pre><tt>diff --combined file</tt></pre> +<pre><code>diff --combined file</code></pre> </div></div> <div class="paragraph"><p>or like this (when <em>--cc</em> option is used):</p></div> <div class="literalblock"> <div class="content"> -<pre><tt>diff --cc file</tt></pre> +<pre><code>diff --cc file</code></pre> </div></div> </li> <li> @@ -1783,12 +1968,12 @@ </p> <div class="literalblock"> <div class="content"> -<pre><tt>index <hash>,<hash>..<hash> +<pre><code>index <hash>,<hash>..<hash> mode <mode>,<mode>..<mode> new file mode <mode> -deleted file mode <mode>,<mode></tt></pre> +deleted file mode <mode>,<mode></code></pre> </div></div> -<div class="paragraph"><p>The <tt>mode <mode>,<mode>..<mode></tt> line appears only if at least one of +<div class="paragraph"><p>The <code>mode <mode>,<mode>..<mode></code> line appears only if at least one of the <mode> is different from the rest. Extended headers with information about detected contents movement (renames and copying detection) are designed to work with diff of two @@ -1800,74 +1985,76 @@ </p> <div class="literalblock"> <div class="content"> -<pre><tt>--- a/file -+++ b/file</tt></pre> +<pre><code>--- a/file ++++ b/file</code></pre> </div></div> <div class="paragraph"><p>Similar to two-line header for traditional <em>unified</em> diff -format, <tt>/dev/null</tt> is used to signal created or deleted +format, <code>/dev/null</code> is used to signal created or deleted files.</p></div> </li> <li> <p> Chunk header format is modified to prevent people from - accidentally feeding it to <tt>patch -p1</tt>. Combined diff format + accidentally feeding it to <code>patch -p1</code>. Combined diff format was created for review of merge commit changes, and was not meant for apply. The change is similar to the change in the extended <em>index</em> header: </p> <div class="literalblock"> <div class="content"> -<pre><tt>@@@ <from-file-range> <from-file-range> <to-file-range> @@@</tt></pre> +<pre><code>@@@ <from-file-range> <from-file-range> <to-file-range> @@@</code></pre> </div></div> -<div class="paragraph"><p>There are (number of parents + 1) <tt>@</tt> characters in the chunk +<div class="paragraph"><p>There are (number of parents + 1) <code>@</code> characters in the chunk header for combined diff format.</p></div> </li> </ol></div> <div class="paragraph"><p>Unlike the traditional <em>unified</em> diff format, which shows two -files A and B with a single column that has <tt>-</tt> (minus — appears in A but removed in B), <tt>+</tt> (plus — missing in A but -added to B), or <tt>" "</tt> (space — unchanged) prefix, this format +files A and B with a single column that has <code>-</code> (minus — appears in A but removed in B), <code>+</code> (plus — missing in A but +added to B), or <code>" "</code> (space — unchanged) prefix, this format compares two or more files file1, file2,… with one file X, and shows how X differs from each of fileN. One column for each of fileN is prepended to the output line to note how X’s line is different from it.</p></div> -<div class="paragraph"><p>A <tt>-</tt> character in the column N means that the line appears in -fileN but it does not appear in the result. A <tt>+</tt> character +<div class="paragraph"><p>A <code>-</code> character in the column N means that the line appears in +fileN but it does not appear in the result. A <code>+</code> character in the column N means that the line appears in the result, and fileN does not have that line (in other words, the line was added, from the point of view of that parent).</p></div> <div class="paragraph"><p>In the above example output, the function signature was changed -from both files (hence two <tt>-</tt> removals from both file1 and -file2, plus <tt>++</tt> to mean one line that was added does not appear +from both files (hence two <code>-</code> removals from both file1 and +file2, plus <code>++</code> to mean one line that was added does not appear in either file1 nor file2). Also eight other lines are the same -from file1 but do not appear in file2 (hence prefixed with <tt>+</tt>).</p></div> -<div class="paragraph"><p>When shown by <tt>git diff-tree -c</tt>, it compares the parents of a +from file1 but do not appear in file2 (hence prefixed with <code>+</code>).</p></div> +<div class="paragraph"><p>When shown by <code>git diff-tree -c</code>, it compares the parents of a merge commit with the merge result (i.e. file1..fileN are the -parents). When shown by <tt>git diff-files -c</tt>, it compares the +parents). When shown by <code>git diff-files -c</code>, it compares the two unresolved merge parents with the working tree file (i.e. file1 is stage 2 aka "our version", file2 is stage 3 aka "their version").</p></div> </div> +</div> +<div class="sect1"> <h2 id="_other_diff_formats">other diff formats</h2> <div class="sectionbody"> -<div class="paragraph"><p>The <tt>--summary</tt> option describes newly added, deleted, renamed and -copied files. The <tt>--stat</tt> option adds diffstat(1) graph to the +<div class="paragraph"><p>The <code>--summary</code> option describes newly added, deleted, renamed and +copied files. The <code>--stat</code> option adds diffstat(1) graph to the output. These options can be combined with other options, such as -<tt>-p</tt>, and are meant for human consumption.</p></div> -<div class="paragraph"><p>When showing a change that involves a rename or a copy, <tt>--stat</tt> output +<code>-p</code>, and are meant for human consumption.</p></div> +<div class="paragraph"><p>When showing a change that involves a rename or a copy, <code>--stat</code> output formats the pathnames compactly by combining common prefix and suffix of -the pathnames. For example, a change that moves <tt>arch/i386/Makefile</tt> to -<tt>arch/x86/Makefile</tt> while modifying 4 lines will be shown like this:</p></div> +the pathnames. For example, a change that moves <code>arch/i386/Makefile</code> to +<code>arch/x86/Makefile</code> while modifying 4 lines will be shown like this:</p></div> <div class="listingblock"> <div class="content"> -<pre><tt>arch/{i386 => x86}/Makefile | 4 +--</tt></pre> +<pre><code>arch/{i386 => x86}/Makefile | 4 +--</code></pre> </div></div> -<div class="paragraph"><p>The <tt>--numstat</tt> option gives the diffstat(1) information but is designed -for easier machine consumption. An entry in <tt>--numstat</tt> output looks +<div class="paragraph"><p>The <code>--numstat</code> option gives the diffstat(1) information but is designed +for easier machine consumption. An entry in <code>--numstat</code> output looks like this:</p></div> <div class="listingblock"> <div class="content"> -<pre><tt>1 2 README -3 1 arch/{i386 => x86}/Makefile</tt></pre> +<pre><code>1 2 README +3 1 arch/{i386 => x86}/Makefile</code></pre> </div></div> <div class="paragraph"><p>That is, from left to right:</p></div> <div class="olist arabic"><ol class="arabic"> @@ -1902,11 +2089,11 @@ </p> </li> </ol></div> -<div class="paragraph"><p>When <tt>-z</tt> output option is in effect, the output is formatted this way:</p></div> +<div class="paragraph"><p>When <code>-z</code> output option is in effect, the output is formatted this way:</p></div> <div class="listingblock"> <div class="content"> -<pre><tt>1 2 README NUL -3 1 NUL arch/i386/Makefile NUL arch/x86/Makefile NUL</tt></pre> +<pre><code>1 2 README NUL +3 1 NUL arch/i386/Makefile NUL arch/x86/Makefile NUL</code></pre> </div></div> <div class="paragraph"><p>That is:</p></div> <div class="olist arabic"><ol class="arabic"> @@ -1956,21 +2143,24 @@ </p> </li> </ol></div> -<div class="paragraph"><p>The extra <tt>NUL</tt> before the preimage path in renamed case is to allow +<div class="paragraph"><p>The extra <code>NUL</code> before the preimage path in renamed case is to allow scripts that read the output to tell if the current record being read is a single-path record or a rename/copy record without reading ahead. -After reading added and deleted lines, reading up to <tt>NUL</tt> would yield -the pathname, but if that is <tt>NUL</tt>, the record will show two paths.</p></div> +After reading added and deleted lines, reading up to <code>NUL</code> would yield +the pathname, but if that is <code>NUL</code>, the record will show two paths.</p></div> </div> +</div> +<div class="sect1"> <h2 id="_git">GIT</h2> <div class="sectionbody"> <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div> </div> </div> +</div> <div id="footnotes"><hr /></div> <div id="footer"> <div id="footer-text"> -Last updated 2011-11-15 13:45:02 PDT +Last updated 2011-11-15 13:45:02 PST </div> </div> </body> diff --git a/git-diff-index.html b/git-diff-index.html index 296694e..c27ff0a 100644 --- a/git-diff-index.html +++ b/git-diff-index.html
@@ -2,15 +2,25 @@ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> <head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> -<meta name="generator" content="AsciiDoc 8.5.2" /> +<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" /> +<meta name="generator" content="AsciiDoc 8.6.8" /> <title>git-diff-index(1)</title> <style type="text/css"> -/* Debug borders */ -p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 { -/* - border: 1px solid red; -*/ +/* Shared CSS for AsciiDoc xhtml11 and html5 backends */ + +/* Default font. */ +body { + font-family: Georgia,serif; +} + +/* Title font. */ +h1, h2, h3, h4, h5, h6, +div.title, caption.title, +thead, p.table.header, +#toctitle, +#author, #revnumber, #revdate, #revremark, +#footer { + font-family: Arial,Helvetica,sans-serif; } body { @@ -35,13 +45,8 @@ color: #083194; } -tt { - color: navy; -} - h1, h2, h3, h4, h5, h6 { color: #527bbd; - font-family: sans-serif; margin-top: 1.2em; margin-bottom: 0.5em; line-height: 1.3; @@ -59,9 +64,11 @@ h3 + * { clear: left; } +h5 { + font-size: 1.0em; +} div.sectionbody { - font-family: serif; margin-left: 0; } @@ -77,45 +84,48 @@ ul, ol, li > p { margin-top: 0; } +ul > li { color: #aaa; } +ul > li > * { color: black; } -pre { +.monospaced, code, pre { + font-family: "Courier New", Courier, monospace; + font-size: inherit; + color: navy; padding: 0; margin: 0; } -span#author { + +#author { color: #527bbd; - font-family: sans-serif; font-weight: bold; font-size: 1.1em; } -span#email { +#email { } -span#revnumber, span#revdate, span#revremark { - font-family: sans-serif; +#revnumber, #revdate, #revremark { } -div#footer { - font-family: sans-serif; +#footer { font-size: small; border-top: 2px solid silver; padding-top: 0.5em; margin-top: 4.0em; } -div#footer-text { +#footer-text { float: left; padding-bottom: 0.5em; } -div#footer-badges { +#footer-badges { float: right; padding-bottom: 0.5em; } -div#preamble { +#preamble { margin-top: 1.5em; margin-bottom: 1.5em; } -div.tableblock, div.imageblock, div.exampleblock, div.verseblock, +div.imageblock, div.exampleblock, div.verseblock, div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock, div.admonitionblock { margin-top: 1.0em; @@ -135,7 +145,6 @@ /* Block element titles. */ div.title, caption.title { color: #527bbd; - font-family: sans-serif; font-weight: bold; text-align: left; margin-top: 1.0em; @@ -157,13 +166,15 @@ div.sidebarblock > div.content { background: #ffffee; - border: 1px solid silver; + border: 1px solid #dddddd; + border-left: 4px solid #f0f0f0; padding: 0.5em; } div.listingblock > div.content { - border: 1px solid silver; - background: #f4f4f4; + border: 1px solid #dddddd; + border-left: 5px solid #f0f0f0; + background: #f8f8f8; padding: 0.5em; } @@ -171,8 +182,8 @@ padding-left: 1.0em; margin-left: 1.0em; margin-right: 10%; - border-left: 5px solid #dddddd; - color: #777777; + border-left: 5px solid #f0f0f0; + color: #888; } div.quoteblock > div.attribution { @@ -180,8 +191,9 @@ text-align: right; } -div.verseblock > div.content { - white-space: pre; +div.verseblock > pre.content { + font-family: inherit; + font-size: inherit; } div.verseblock > div.attribution { padding-top: 0.75em; @@ -254,35 +266,12 @@ margin-bottom: 0.1em; } -div.tableblock > table { - border: 3px solid #527bbd; -} -thead, p.table.header { - font-family: sans-serif; - font-weight: bold; -} tfoot { font-weight: bold; } td > div.verse { white-space: pre; } -p.table { - margin-top: 0; -} -/* Because the table frame attribute is overriden by CSS in most browsers. */ -div.tableblock > table[frame="void"] { - border-style: none; -} -div.tableblock > table[frame="hsides"] { - border-left-style: none; - border-right-style: none; -} -div.tableblock > table[frame="vsides"] { - border-top-style: none; - border-bottom-style: none; -} - div.hdlist { margin-top: 0.8em; @@ -339,25 +328,32 @@ min-width: 100px; } - -@media print { - div#footer-badges { display: none; } +div.colist td { + padding-right: 0.5em; + padding-bottom: 0.3em; + vertical-align: top; +} +div.colist td img { + margin-top: 0.3em; } -div#toc { +@media print { + #footer-badges { display: none; } +} + +#toc { margin-bottom: 2.5em; } -div#toctitle { +#toctitle { color: #527bbd; - font-family: sans-serif; font-size: 1.1em; font-weight: bold; margin-top: 1.0em; margin-bottom: 0.1em; } -div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 { +div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 { margin-top: 0; margin-bottom: 0; } @@ -373,69 +369,173 @@ margin-left: 6em; font-size: 0.9em; } -/* Overrides for manpage documents */ -h1 { + +span.aqua { color: aqua; } +span.black { color: black; } +span.blue { color: blue; } +span.fuchsia { color: fuchsia; } +span.gray { color: gray; } +span.green { color: green; } +span.lime { color: lime; } +span.maroon { color: maroon; } +span.navy { color: navy; } +span.olive { color: olive; } +span.purple { color: purple; } +span.red { color: red; } +span.silver { color: silver; } +span.teal { color: teal; } +span.white { color: white; } +span.yellow { color: yellow; } + +span.aqua-background { background: aqua; } +span.black-background { background: black; } +span.blue-background { background: blue; } +span.fuchsia-background { background: fuchsia; } +span.gray-background { background: gray; } +span.green-background { background: green; } +span.lime-background { background: lime; } +span.maroon-background { background: maroon; } +span.navy-background { background: navy; } +span.olive-background { background: olive; } +span.purple-background { background: purple; } +span.red-background { background: red; } +span.silver-background { background: silver; } +span.teal-background { background: teal; } +span.white-background { background: white; } +span.yellow-background { background: yellow; } + +span.big { font-size: 2em; } +span.small { font-size: 0.6em; } + +span.underline { text-decoration: underline; } +span.overline { text-decoration: overline; } +span.line-through { text-decoration: line-through; } + +div.unbreakable { page-break-inside: avoid; } + + +/* + * xhtml11 specific + * + * */ + +div.tableblock { + margin-top: 1.0em; + margin-bottom: 1.5em; +} +div.tableblock > table { + border: 3px solid #527bbd; +} +thead, p.table.header { + font-weight: bold; + color: #527bbd; +} +p.table { + margin-top: 0; +} +/* Because the table frame attribute is overriden by CSS in most browsers. */ +div.tableblock > table[frame="void"] { + border-style: none; +} +div.tableblock > table[frame="hsides"] { + border-left-style: none; + border-right-style: none; +} +div.tableblock > table[frame="vsides"] { + border-top-style: none; + border-bottom-style: none; +} + + +/* + * html5 specific + * + * */ + +table.tableblock { + margin-top: 1.0em; + margin-bottom: 1.5em; +} +thead, p.tableblock.header { + font-weight: bold; + color: #527bbd; +} +p.tableblock { + margin-top: 0; +} +table.tableblock { + border-width: 3px; + border-spacing: 0px; + border-style: solid; + border-color: #527bbd; + border-collapse: collapse; +} +th.tableblock, td.tableblock { + border-width: 1px; + padding: 4px; + border-style: solid; + border-color: #527bbd; +} + +table.tableblock.frame-topbot { + border-left-style: hidden; + border-right-style: hidden; +} +table.tableblock.frame-sides { + border-top-style: hidden; + border-bottom-style: hidden; +} +table.tableblock.frame-none { + border-style: hidden; +} + +th.tableblock.halign-left, td.tableblock.halign-left { + text-align: left; +} +th.tableblock.halign-center, td.tableblock.halign-center { + text-align: center; +} +th.tableblock.halign-right, td.tableblock.halign-right { + text-align: right; +} + +th.tableblock.valign-top, td.tableblock.valign-top { + vertical-align: top; +} +th.tableblock.valign-middle, td.tableblock.valign-middle { + vertical-align: middle; +} +th.tableblock.valign-bottom, td.tableblock.valign-bottom { + vertical-align: bottom; +} + + +/* + * manpage specific + * + * */ + +body.manpage h1 { padding-top: 0.5em; padding-bottom: 0.5em; border-top: 2px solid silver; border-bottom: 2px solid silver; } -h2 { +body.manpage h2 { border-style: none; } -div.sectionbody { - margin-left: 5%; +body.manpage div.sectionbody { + margin-left: 3em; } @media print { - div#toc { display: none; } + body.manpage div#toc { display: none; } } -/* Workarounds for IE6's broken and incomplete CSS2. */ -div.sidebar-content { - background: #ffffee; - border: 1px solid silver; - padding: 0.5em; -} -div.sidebar-title, div.image-title { - color: #527bbd; - font-family: sans-serif; - font-weight: bold; - margin-top: 0.0em; - margin-bottom: 0.5em; -} - -div.listingblock div.content { - border: 1px solid silver; - background: #f4f4f4; - padding: 0.5em; -} - -div.quoteblock-attribution { - padding-top: 0.5em; - text-align: right; -} - -div.verseblock-content { - white-space: pre; -} -div.verseblock-attribution { - padding-top: 0.75em; - text-align: left; -} - -div.exampleblock-content { - border-left: 3px solid #dddddd; - padding-left: 0.5em; -} - -/* IE6 sets dynamically generated links as visited. */ -div#toc a:visited { color: blue; } </style> <script type="text/javascript"> /*<+'])'); + var re = new RegExp('[hH]([1-'+(toclevels+1)+'])'); // Function that scans the DOM tree for header elements (the DOM2 // nodeIterator API would be a better technique but not supported by all // browsers). @@ -497,6 +597,25 @@ } var toc = document.getElementById("toc"); + if (!toc) { + return; + } + + // Delete existing TOC entries in case we're reloading the TOC. + var tocEntriesToRemove = []; + var i; + for (i = 0; i < toc.childNodes.length; i++) { + var entry = toc.childNodes[i]; + if (entry.nodeName.toLowerCase() == 'div' + && entry.getAttribute("class") + && entry.getAttribute("class").match(/^toclevel/)) + tocEntriesToRemove.push(entry); + } + for (i = 0; i < tocEntriesToRemove.length; i++) { + toc.removeChild(tocEntriesToRemove[i]); + } + + // Rebuild TOC entries. var entries = tocEntries(document.getElementById("content"), toclevels); for (var i = 0; i < entries.length; ++i) { var entry = entries[i]; @@ -524,24 +643,44 @@ */ footnotes: function () { - var cont = document.getElementById("content"); + // Delete existing footnote entries in case we're reloading the footnodes. + var i; var noteholder = document.getElementById("footnotes"); + if (!noteholder) { + return; + } + var entriesToRemove = []; + for (i = 0; i < noteholder.childNodes.length; i++) { + var entry = noteholder.childNodes[i]; + if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote") + entriesToRemove.push(entry); + } + for (i = 0; i < entriesToRemove.length; i++) { + noteholder.removeChild(entriesToRemove[i]); + } + + // Rebuild footnote entries. + var cont = document.getElementById("content"); var spans = cont.getElementsByTagName("span"); var refs = {}; var n = 0; for (i=0; i<spans.length; i++) { if (spans[i].className == "footnote") { n++; - // Use [\s\S] in place of . so multi-line matches work. - // Because JavaScript has no s (dotall) regex flag. - note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1]; + var note = spans[i].getAttribute("data-note"); + if (!note) { + // Use [\s\S] in place of . so multi-line matches work. + // Because JavaScript has no s (dotall) regex flag. + note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1]; + spans[i].innerHTML = + "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n + + "' title='View footnote' class='footnote'>" + n + "</a>]"; + spans[i].setAttribute("data-note", note); + } noteholder.innerHTML += "<div class='footnote' id='_footnote_" + n + "'>" + "<a href='#_footnoteref_" + n + "' title='Return to text'>" + n + "</a>. " + note + "</div>"; - spans[i].innerHTML = - "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n + - "' title='View footnote' class='footnote'>" + n + "</a>]"; var id =spans[i].getAttribute("id"); if (id != null) refs["#"+id] = n; } @@ -561,13 +700,36 @@ } } } +}, + +install: function(toclevels) { + var timerId; + + function reinstall() { + asciidoc.footnotes(); + if (toclevels) { + asciidoc.toc(toclevels); + } + } + + function reinstallAndRemoveTimer() { + clearInterval(timerId); + reinstall(); + } + + timerId = setInterval(reinstall, 500); + if (document.addEventListener) + document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false); + else + window.onload = reinstallAndRemoveTimer; } } +asciidoc.install(); /*]]>*/ </script> </head> -<body> +<body class="manpage"> <div id="header"> <h1> git-diff-index(1) Manual Page @@ -580,13 +742,16 @@ </div> </div> <div id="content"> +<div class="sect1"> <h2 id="_synopsis">SYNOPSIS</h2> <div class="sectionbody"> <div class="verseblock"> -<div class="verseblock-content"><em>git diff-index</em> [-m] [--cached] [<common diff options>] <tree-ish> [<path>…]</div> -<div class="verseblock-attribution"> +<pre class="content"><em>git diff-index</em> [-m] [--cached] [<common diff options>] <tree-ish> [<path>…]</pre> +<div class="attribution"> </div></div> </div> +</div> +<div class="sect1"> <h2 id="_description">DESCRIPTION</h2> <div class="sectionbody"> <div class="paragraph"><p>Compares the content and mode of the blobs found via a tree @@ -595,6 +760,8 @@ specified, compares only those named paths. Otherwise all entries in the index are compared.</p></div> </div> +</div> +<div class="sect1"> <h2 id="_options">OPTIONS</h2> <div class="sectionbody"> <div class="dlist"><dl> @@ -623,7 +790,7 @@ <p> Generate diffs with <n> lines of context instead of the usual three. - Implies <tt>-p</tt>. + Implies <code>-p</code>. </p> </dd> <dt class="hdlist1"> @@ -640,7 +807,7 @@ </dt> <dd> <p> - Synonym for <tt>-p --raw</tt>. + Synonym for <code>-p --raw</code>. </p> </dd> <dt class="hdlist1"> @@ -677,29 +844,29 @@ will be used for the filename part, and the rest for the graph part. Maximum width defaults to terminal width, or 80 columns if not connected to a terminal, and can be overridden by - <tt><width></tt>. The width of the filename part can be limited by - giving another width <tt><name-width></tt> after a comma. The width + <code><width></code>. The width of the filename part can be limited by + giving another width <code><name-width></code> after a comma. The width of the graph part can be limited by using - <tt>--stat-graph-width=<width></tt> (affects all commands generating - a stat graph) or by setting <tt>diff.statGraphWidth=<width></tt> - (does not affect <tt>git format-patch</tt>). - By giving a third parameter <tt><count></tt>, you can limit the - output to the first <tt><count></tt> lines, followed by <tt>...</tt> if + <code>--stat-graph-width=<width></code> (affects all commands generating + a stat graph) or by setting <code>diff.statGraphWidth=<width></code> + (does not affect <code>git format-patch</code>). + By giving a third parameter <code><count></code>, you can limit the + output to the first <code><count></code> lines, followed by <code>...</code> if there are more. </p> -<div class="paragraph"><p>These parameters can also be set individually with <tt>--stat-width=<width></tt>, -<tt>--stat-name-width=<name-width></tt> and <tt>--stat-count=<count></tt>.</p></div> +<div class="paragraph"><p>These parameters can also be set individually with <code>--stat-width=<width></code>, +<code>--stat-name-width=<name-width></code> and <code>--stat-count=<count></code>.</p></div> </dd> <dt class="hdlist1"> --numstat </dt> <dd> <p> - Similar to <tt>--stat</tt>, but shows number of added and + Similar to <code>--stat</code>, but shows number of added and deleted lines in decimal notation and pathname without abbreviation, to make it more machine friendly. For - binary files, outputs two <tt>-</tt> instead of saying - <tt>0 0</tt>. + binary files, outputs two <code>-</code> instead of saying + <code>0 0</code>. </p> </dd> <dt class="hdlist1"> @@ -707,7 +874,7 @@ </dt> <dd> <p> - Output only the last line of the <tt>--stat</tt> format containing total + Output only the last line of the <code>--stat</code> format containing total number of modified files, as well as number of added and deleted lines. </p> @@ -718,15 +885,17 @@ <dd> <p> Output the distribution of relative amount of changes for each - sub-directory. The behavior of <tt>--dirstat</tt> can be customized by + sub-directory. The behavior of <code>--dirstat</code> can be customized by passing it a comma separated list of parameters. - The defaults are controlled by the <tt>diff.dirstat</tt> configuration + The defaults are controlled by the <code>diff.dirstat</code> configuration variable (see <a href="git-config.html">git-config(1)</a>). The following parameters are available: </p> +<div class="openblock"> +<div class="content"> <div class="dlist"><dl> <dt class="hdlist1"> -<tt>changes</tt> +<code>changes</code> </dt> <dd> <p> @@ -738,39 +907,39 @@ </p> </dd> <dt class="hdlist1"> -<tt>lines</tt> +<code>lines</code> </dt> <dd> <p> Compute the dirstat numbers by doing the regular line-based diff analysis, and summing the removed/added line counts. (For binary files, count 64-byte chunks instead, since binary files have no - natural concept of lines). This is a more expensive <tt>--dirstat</tt> - behavior than the <tt>changes</tt> behavior, but it does count rearranged + natural concept of lines). This is a more expensive <code>--dirstat</code> + behavior than the <code>changes</code> behavior, but it does count rearranged lines within a file as much as other changes. The resulting output - is consistent with what you get from the other <tt>--*stat</tt> options. + is consistent with what you get from the other <code>--*stat</code> options. </p> </dd> <dt class="hdlist1"> -<tt>files</tt> +<code>files</code> </dt> <dd> <p> Compute the dirstat numbers by counting the number of files changed. Each changed file counts equally in the dirstat analysis. This is - the computationally cheapest <tt>--dirstat</tt> behavior, since it does + the computationally cheapest <code>--dirstat</code> behavior, since it does not have to look at the file contents at all. </p> </dd> <dt class="hdlist1"> -<tt>cumulative</tt> +<code>cumulative</code> </dt> <dd> <p> Count changes in a child directory for the parent directory as well. - Note that when using <tt>cumulative</tt>, the sum of the percentages + Note that when using <code>cumulative</code>, the sum of the percentages reported may exceed 100%. The default (non-cumulative) behavior can - be specified with the <tt>noncumulative</tt> parameter. + be specified with the <code>noncumulative</code> parameter. </p> </dd> <dt class="hdlist1"> @@ -784,10 +953,11 @@ </p> </dd> </dl></div> +</div></div> <div class="paragraph"><p>Example: The following will count changed files, while ignoring directories with less than 10% of the total amount of changed files, and accumulating child directory counts in the parent directories: -<tt>--dirstat=files,10,cumulative</tt>.</p></div> +<code>--dirstat=files,10,cumulative</code>.</p></div> </dd> <dt class="hdlist1"> --summary @@ -803,7 +973,7 @@ </dt> <dd> <p> - Synonym for <tt>-p --stat</tt>. + Synonym for <code>-p --stat</code>. </p> </dd> <dt class="hdlist1"> @@ -811,11 +981,11 @@ </dt> <dd> <p> - When <tt>--raw</tt>, <tt>--numstat</tt>, <tt>--name-only</tt> or <tt>--name-status</tt> has been + When <code>--raw</code>, <code>--numstat</code>, <code>--name-only</code> or <code>--name-status</code> has been given, do not munge pathnames and use NULs as output field terminators. </p> <div class="paragraph"><p>Without this option, each pathname output will have TAB, LF, double quotes, -and backslash characters replaced with <tt>\t</tt>, <tt>\n</tt>, <tt>\"</tt>, and <tt>\\</tt>, +and backslash characters replaced with <code>\t</code>, <code>\n</code>, <code>\"</code>, and <code>\\</code>, respectively, and the pathname will be enclosed in double quotes if any of those replacements occurred.</p></div> </dd> @@ -833,7 +1003,7 @@ <dd> <p> Show only names and status of changed files. See the description - of the <tt>--diff-filter</tt> option on what the status letters mean. + of the <code>--diff-filter</code> option on what the status letters mean. </p> </dd> <dt class="hdlist1"> @@ -841,13 +1011,13 @@ </dt> <dd> <p> - Specify how differences in submodules are shown. When <tt>--submodule</tt> - or <tt>--submodule=log</tt> is given, the <em>log</em> format is used. This format lists - the commits in the range like <a href="git-submodule.html">git-submodule(1)</a> <tt>summary</tt> does. - Omitting the <tt>--submodule</tt> option or specifying <tt>--submodule=short</tt>, + Specify how differences in submodules are shown. When <code>--submodule</code> + or <code>--submodule=log</code> is given, the <em>log</em> format is used. This format lists + the commits in the range like <a href="git-submodule.html">git-submodule(1)</a> <code>summary</code> does. + Omitting the <code>--submodule</code> option or specifying <code>--submodule=short</code>, uses the <em>short</em> format. This format just shows the names of the commits at the beginning and end of the range. Can be tweaked via the - <tt>diff.submodule</tt> configuration variable. + <code>diff.submodule</code> configuration variable. </p> </dd> <dt class="hdlist1"> @@ -856,8 +1026,8 @@ <dd> <p> Show colored diff. - The value must be <tt>always</tt> (the default for <tt><when></tt>), <tt>never</tt>, or <tt>auto</tt>. - The default value is <tt>never</tt>. + The value must be <code>always</code> (the default for <code><when></code>), <code>never</code>, or <code>auto</code>. + The default value is <code>never</code>. </p> </dd> <dt class="hdlist1"> @@ -866,7 +1036,7 @@ <dd> <p> Turn off colored diff. - It is the same as <tt>--color=never</tt>. + It is the same as <code>--color=never</code>. </p> </dd> <dt class="hdlist1"> @@ -876,16 +1046,18 @@ <p> Show a word diff, using the <mode> to delimit changed words. By default, words are delimited by whitespace; see - <tt>--word-diff-regex</tt> below. The <mode> defaults to <em>plain</em>, and + <code>--word-diff-regex</code> below. The <mode> defaults to <em>plain</em>, and must be one of: </p> +<div class="openblock"> +<div class="content"> <div class="dlist"><dl> <dt class="hdlist1"> color </dt> <dd> <p> - Highlight changed words using only colors. Implies <tt>--color</tt>. + Highlight changed words using only colors. Implies <code>--color</code>. </p> </dd> <dt class="hdlist1"> @@ -893,7 +1065,7 @@ </dt> <dd> <p> - Show words as <tt>[-removed-]</tt> and <tt>{+added+}</tt>. Makes no + Show words as <code>[-removed-]</code> and <code>{+added+}</code>. Makes no attempts to escape the delimiters if they appear in the input, so the output may be ambiguous. </p> @@ -905,10 +1077,10 @@ <p> Use a special line-based format intended for script consumption. Added/removed/unchanged runs are printed in the - usual unified diff format, starting with a <tt>+</tt>/<tt>-</tt>/` ` + usual unified diff format, starting with a <code>+</code>/<code>-</code>/` ` character at the beginning of the line and extending to the end of the line. Newlines in the input are represented by a - tilde <tt>~</tt> on a line of its own. + tilde <code>~</code> on a line of its own. </p> </dd> <dt class="hdlist1"> @@ -920,6 +1092,7 @@ </p> </dd> </dl></div> +</div></div> <div class="paragraph"><p>Note that despite the name of the first mode, color is used to highlight the changed parts in all modes if enabled.</p></div> </dd> @@ -930,12 +1103,12 @@ <p> Use <regex> to decide what a word is, instead of considering runs of non-whitespace to be a word. Also implies - <tt>--word-diff</tt> unless it was already enabled. + <code>--word-diff</code> unless it was already enabled. </p> <div class="paragraph"><p>Every non-overlapping match of the <regex> is considered a word. Anything between these matches is considered whitespace and ignored(!) for the purposes of finding -differences. You may want to append <tt>|[^[:space:]]</tt> to your regular +differences. You may want to append <code>|[^[:space:]]</code> to your regular expression to make sure that it matches all non-whitespace characters. A match that contains a newline is silently truncated(!) at the newline.</p></div> @@ -949,8 +1122,8 @@ </dt> <dd> <p> - Equivalent to <tt>--word-diff=color</tt> plus (if a regex was - specified) <tt>--word-diff-regex=<regex></tt>. + Equivalent to <code>--word-diff=color</code> plus (if a regex was + specified) <code>--word-diff-regex=<regex></code>. </p> </dd> <dt class="hdlist1"> @@ -968,7 +1141,7 @@ <dd> <p> Warn if changes introduce whitespace errors. What are - considered whitespace errors is controlled by <tt>core.whitespace</tt> + considered whitespace errors is controlled by <code>core.whitespace</code> configuration. By default, trailing whitespaces (including lines that solely consist of whitespaces) and a space character that is immediately followed by a tab character inside the @@ -992,8 +1165,8 @@ </dt> <dd> <p> - In addition to <tt>--full-index</tt>, output a binary diff that - can be applied with <tt>git-apply</tt>. + In addition to <code>--full-index</code>, output a binary diff that + can be applied with <code>git-apply</code>. </p> </dd> <dt class="hdlist1"> @@ -1004,9 +1177,9 @@ Instead of showing the full 40-byte hexadecimal object name in diff-raw format output and diff-tree header lines, show only a partial prefix. This is - independent of the <tt>--full-index</tt> option above, which controls + independent of the <code>--full-index</code> option above, which controls the diff-patch output format. Non default number of - digits can be specified with <tt>--abbrev=<n></tt>. + digits can be specified with <code>--abbrev=<n></code>. </p> </dd> <dt class="hdlist1"> @@ -1024,15 +1197,15 @@ not as a series of deletion and insertion mixed together with a very few lines that happen to match textually as the context, but as a single deletion of everything old followed by a single insertion of -everything new, and the number <tt>m</tt> controls this aspect of the -B -option (defaults to 60%). <tt>-B/70%</tt> specifies that less than 30% of the +everything new, and the number <code>m</code> controls this aspect of the -B +option (defaults to 60%). <code>-B/70%</code> specifies that less than 30% of the original should remain in the result for git to consider it a total rewrite (i.e. otherwise the resulting patch will be a series of deletion and insertion mixed together with context lines).</p></div> <div class="paragraph"><p>When used with -M, a totally-rewritten file is also considered as the source of a rename (usually -M only considers a file that disappeared -as the source of a rename), and the number <tt>n</tt> controls this aspect of -the -B option (defaults to 50%). <tt>-B20%</tt> specifies that a change with +as the source of a rename), and the number <code>n</code> controls this aspect of +the -B option (defaults to 50%). <code>-B20%</code> specifies that a change with addition and deletion compared to 20% or more of the file’s size are eligible for being picked up as a possible source of a rename to another file.</p></div> @@ -1046,11 +1219,15 @@ <dd> <p> Detect renames. - If <tt>n</tt> is specified, it is a threshold on the similarity + If <code>n</code> is specified, it is a threshold on the similarity index (i.e. amount of addition/deletions compared to the - file’s size). For example, <tt>-M90%</tt> means git should consider a + file’s size). For example, <code>-M90%</code> means git should consider a delete/add pair to be a rename if more than 90% of the file - hasn’t changed. + hasn’t changed. Without a <code>%</code> sign, the number is to be read as + a fraction, with a decimal point before it. I.e., <code>-M5</code> becomes + 0.5, and is thus the same as <code>-M50%</code>. Similarly, <code>-M05</code> is + the same as <code>-M5%</code>. To limit detection to exact renames, use + <code>-M100%</code>. </p> </dd> <dt class="hdlist1"> @@ -1061,8 +1238,8 @@ </dt> <dd> <p> - Detect copies as well as renames. See also <tt>--find-copies-harder</tt>. - If <tt>n</tt> is specified, it has the same meaning as for <tt>-M<n></tt>. + Detect copies as well as renames. See also <code>--find-copies-harder</code>. + If <code>n</code> is specified, it has the same meaning as for <code>-M<n></code>. </p> </dd> <dt class="hdlist1"> @@ -1070,13 +1247,13 @@ </dt> <dd> <p> - For performance reasons, by default, <tt>-C</tt> option finds copies only + For performance reasons, by default, <code>-C</code> option finds copies only if the original file of the copy was modified in the same changeset. This flag makes the command inspect unmodified files as candidates for the source of copy. This is a very expensive operation for large projects, so use it with caution. Giving more than one - <tt>-C</tt> option has the same effect. + <code>-C</code> option has the same effect. </p> </dd> <dt class="hdlist1"> @@ -1088,14 +1265,14 @@ <dd> <p> Omit the preimage for deletes, i.e. print only the header but not - the diff between the preimage and <tt>/dev/null</tt>. The resulting patch - is not meant to be applied with <tt>patch</tt> nor <tt>git apply</tt>; this is + the diff between the preimage and <code>/dev/null</code>. The resulting patch + is not meant to be applied with <code>patch</code> nor <code>git apply</code>; this is solely for people who want to just concentrate on reviewing the text after the change. In addition, the output obviously lack enough information to apply such a patch in reverse, even manually, hence the name of the option. </p> -<div class="paragraph"><p>When used together with <tt>-B</tt>, omit also the preimage in the deletion part +<div class="paragraph"><p>When used together with <code>-B</code>, omit also the preimage in the deletion part of a delete/create pair.</p></div> </dd> <dt class="hdlist1"> @@ -1103,7 +1280,7 @@ </dt> <dd> <p> - The <tt>-M</tt> and <tt>-C</tt> options require O(n^2) processing time where n + The <code>-M</code> and <code>-C</code> options require O(n^2) processing time where n is the number of potential rename/copy targets. This option prevents rename/copy detection from running if the number of rename/copy targets exceeds the specified @@ -1115,13 +1292,13 @@ </dt> <dd> <p> - Select only files that are Added (<tt>A</tt>), Copied (<tt>C</tt>), - Deleted (<tt>D</tt>), Modified (<tt>M</tt>), Renamed (<tt>R</tt>), have their - type (i.e. regular file, symlink, submodule, …) changed (<tt>T</tt>), - are Unmerged (<tt>U</tt>), are - Unknown (<tt>X</tt>), or have had their pairing Broken (<tt>B</tt>). + Select only files that are Added (<code>A</code>), Copied (<code>C</code>), + Deleted (<code>D</code>), Modified (<code>M</code>), Renamed (<code>R</code>), have their + type (i.e. regular file, symlink, submodule, …) changed (<code>T</code>), + are Unmerged (<code>U</code>), are + Unknown (<code>X</code>), or have had their pairing Broken (<code>B</code>). Any combination of the filter characters (including none) can be used. - When <tt>*</tt> (All-or-none) is added to the combination, all + When <code>*</code> (All-or-none) is added to the combination, all paths are selected if there is any file that matches other criteria in the comparison; if there is no file that matches other criteria, nothing is selected. @@ -1152,7 +1329,7 @@ </dt> <dd> <p> - When <tt>-S</tt> or <tt>-G</tt> finds a change, show all the changes in that + When <code>-S</code> or <code>-G</code> finds a change, show all the changes in that changeset, not just the files that contain the change in <string>. </p> @@ -1277,7 +1454,7 @@ </dt> <dd> <p> - Disable all output of the program. Implies <tt>--exit-code</tt>. + Disable all output of the program. Implies <code>--exit-code</code>. </p> </dd> <dt class="hdlist1"> @@ -1391,6 +1568,8 @@ </dd> </dl></div> </div> +</div> +<div class="sect1"> <h2 id="_raw_output_format">Raw output format</h2> <div class="sectionbody"> <div class="paragraph"><p>The raw output format from "git-diff-index", "git-diff-tree", @@ -1437,12 +1616,12 @@ <div class="paragraph"><p>An output line is formatted this way:</p></div> <div class="listingblock"> <div class="content"> -<pre><tt>in-place edit :100644 100644 bcd1234... 0123456... M file0 +<pre><code>in-place edit :100644 100644 bcd1234... 0123456... M file0 copy-edit :100644 100644 abcd123... 1234567... C68 file1 file2 rename-edit :100644 100644 abcd123... 1234567... R86 file1 file3 create :000000 100644 0000000... 1234567... A file4 delete :100644 000000 1234567... 0000000... D file5 -unmerged :000000 000000 0000000... 0000000... U file6</tt></pre> +unmerged :000000 000000 0000000... 0000000... U file6</code></pre> </div></div> <div class="paragraph"><p>That is, from the left to the right:</p></div> <div class="olist arabic"><ol class="arabic"> @@ -1574,12 +1753,14 @@ <div class="paragraph"><p>Example:</p></div> <div class="listingblock"> <div class="content"> -<pre><tt>:100644 100644 5be4a4...... 000000...... M file.c</tt></pre> +<pre><code>:100644 100644 5be4a4...... 000000...... M file.c</code></pre> </div></div> -<div class="paragraph"><p>When <tt>-z</tt> option is not used, TAB, LF, and backslash characters -in pathnames are represented as <tt>\t</tt>, <tt>\n</tt>, and <tt>\\</tt>, +<div class="paragraph"><p>When <code>-z</code> option is not used, TAB, LF, and backslash characters +in pathnames are represented as <code>\t</code>, <code>\n</code>, and <code>\\</code>, respectively.</p></div> </div> +</div> +<div class="sect1"> <h2 id="_diff_format_for_merges">diff format for merges</h2> <div class="sectionbody"> <div class="paragraph"><p>"git-diff-tree", "git-diff-files" and "git-diff --raw" @@ -1616,11 +1797,13 @@ <div class="paragraph"><p>Example:</p></div> <div class="listingblock"> <div class="content"> -<pre><tt>::100644 100644 100644 fabadb8... cc95eb0... 4866510... MM describe.c</tt></pre> +<pre><code>::100644 100644 100644 fabadb8... cc95eb0... 4866510... MM describe.c</code></pre> </div></div> <div class="paragraph"><p>Note that <em>combined diff</em> lists only files which were modified from all parents.</p></div> </div> +</div> +<div class="sect1"> <h2 id="_generating_patches_with_p">Generating patches with -p</h2> <div class="sectionbody"> <div class="paragraph"><p>When "git-diff-index", "git-diff-tree", or "git-diff-files" are run @@ -1638,12 +1821,12 @@ </p> <div class="literalblock"> <div class="content"> -<pre><tt>diff --git a/file1 b/file2</tt></pre> +<pre><code>diff --git a/file1 b/file2</code></pre> </div></div> -<div class="paragraph"><p>The <tt>a/</tt> and <tt>b/</tt> filenames are the same unless rename/copy is +<div class="paragraph"><p>The <code>a/</code> and <code>b/</code> filenames are the same unless rename/copy is involved. Especially, even for a creation or a deletion, -<tt>/dev/null</tt> is <em>not</em> used in place of the <tt>a/</tt> or <tt>b/</tt> filenames.</p></div> -<div class="paragraph"><p>When rename/copy is involved, <tt>file1</tt> and <tt>file2</tt> show the +<code>/dev/null</code> is <em>not</em> used in place of the <code>a/</code> or <code>b/</code> filenames.</p></div> +<div class="paragraph"><p>When rename/copy is involved, <code>file1</code> and <code>file2</code> show the name of the source file of the rename/copy and the name of the file that rename/copy produces, respectively.</p></div> </li> @@ -1653,7 +1836,7 @@ </p> <div class="literalblock"> <div class="content"> -<pre><tt>old mode <mode> +<pre><code>old mode <mode> new mode <mode> deleted file mode <mode> new file mode <mode> @@ -1663,11 +1846,11 @@ rename to <path> similarity index <number> dissimilarity index <number> -index <hash>..<hash> <mode></tt></pre> +index <hash>..<hash> <mode></code></pre> </div></div> <div class="paragraph"><p>File modes are printed as 6-digit octal numbers including the file type and file permission bits.</p></div> -<div class="paragraph"><p>Path names in extended headers do not include the <tt>a/</tt> and <tt>b/</tt> prefixes.</p></div> +<div class="paragraph"><p>Path names in extended headers do not include the <code>a/</code> and <code>b/</code> prefixes.</p></div> <div class="paragraph"><p>The similarity index is the percentage of unchanged lines, and the dissimilarity index is the percentage of changed lines. It is a rounded down integer, followed by a percent sign. The @@ -1681,33 +1864,35 @@ <li> <p> TAB, LF, double quote and backslash characters in pathnames - are represented as <tt>\t</tt>, <tt>\n</tt>, <tt>\"</tt> and <tt>\\</tt>, respectively. + are represented as <code>\t</code>, <code>\n</code>, <code>\"</code> and <code>\\</code>, respectively. If there is need for such substitution then the whole pathname is put in double quotes. </p> </li> <li> <p> -All the <tt>file1</tt> files in the output refer to files before the - commit, and all the <tt>file2</tt> files refer to files after the commit. +All the <code>file1</code> files in the output refer to files before the + commit, and all the <code>file2</code> files refer to files after the commit. It is incorrect to apply each change to each file sequentially. For example, this patch will swap a and b: </p> <div class="literalblock"> <div class="content"> -<pre><tt>diff --git a/a b/b +<pre><code>diff --git a/a b/b rename from a rename to b diff --git a/b b/a rename from b -rename to a</tt></pre> +rename to a</code></pre> </div></div> </li> </ol></div> </div> +</div> +<div class="sect1"> <h2 id="_combined_diff_format">combined diff format</h2> <div class="sectionbody"> -<div class="paragraph"><p>Any diff-generating command can take the ‘-c` or <tt>--cc</tt> option to +<div class="paragraph"><p>Any diff-generating command can take the ‘-c` or <code>--cc</code> option to produce a <em>combined diff</em> when showing a merge. This is the default format when showing merges with <a href="git-diff.html">git-diff(1)</a> or <a href="git-show.html">git-show(1)</a>. Note also that you can give the `-m’ option to any @@ -1716,7 +1901,7 @@ <div class="paragraph"><p>A <em>combined diff</em> format looks like this:</p></div> <div class="listingblock"> <div class="content"> -<pre><tt>diff --combined describe.c +<pre><code>diff --combined describe.c index fabadb8,cc95eb0..4866510 --- a/describe.c +++ b/describe.c @@ -1742,7 +1927,7 @@ + if (!initialized) { initialized = 1; - for_each_ref(get_name);</tt></pre> + for_each_ref(get_name);</code></pre> </div></div> <div class="olist arabic"><ol class="arabic"> <li> @@ -1752,12 +1937,12 @@ </p> <div class="literalblock"> <div class="content"> -<pre><tt>diff --combined file</tt></pre> +<pre><code>diff --combined file</code></pre> </div></div> <div class="paragraph"><p>or like this (when <em>--cc</em> option is used):</p></div> <div class="literalblock"> <div class="content"> -<pre><tt>diff --cc file</tt></pre> +<pre><code>diff --cc file</code></pre> </div></div> </li> <li> @@ -1767,12 +1952,12 @@ </p> <div class="literalblock"> <div class="content"> -<pre><tt>index <hash>,<hash>..<hash> +<pre><code>index <hash>,<hash>..<hash> mode <mode>,<mode>..<mode> new file mode <mode> -deleted file mode <mode>,<mode></tt></pre> +deleted file mode <mode>,<mode></code></pre> </div></div> -<div class="paragraph"><p>The <tt>mode <mode>,<mode>..<mode></tt> line appears only if at least one of +<div class="paragraph"><p>The <code>mode <mode>,<mode>..<mode></code> line appears only if at least one of the <mode> is different from the rest. Extended headers with information about detected contents movement (renames and copying detection) are designed to work with diff of two @@ -1784,74 +1969,76 @@ </p> <div class="literalblock"> <div class="content"> -<pre><tt>--- a/file -+++ b/file</tt></pre> +<pre><code>--- a/file ++++ b/file</code></pre> </div></div> <div class="paragraph"><p>Similar to two-line header for traditional <em>unified</em> diff -format, <tt>/dev/null</tt> is used to signal created or deleted +format, <code>/dev/null</code> is used to signal created or deleted files.</p></div> </li> <li> <p> Chunk header format is modified to prevent people from - accidentally feeding it to <tt>patch -p1</tt>. Combined diff format + accidentally feeding it to <code>patch -p1</code>. Combined diff format was created for review of merge commit changes, and was not meant for apply. The change is similar to the change in the extended <em>index</em> header: </p> <div class="literalblock"> <div class="content"> -<pre><tt>@@@ <from-file-range> <from-file-range> <to-file-range> @@@</tt></pre> +<pre><code>@@@ <from-file-range> <from-file-range> <to-file-range> @@@</code></pre> </div></div> -<div class="paragraph"><p>There are (number of parents + 1) <tt>@</tt> characters in the chunk +<div class="paragraph"><p>There are (number of parents + 1) <code>@</code> characters in the chunk header for combined diff format.</p></div> </li> </ol></div> <div class="paragraph"><p>Unlike the traditional <em>unified</em> diff format, which shows two -files A and B with a single column that has <tt>-</tt> (minus — appears in A but removed in B), <tt>+</tt> (plus — missing in A but -added to B), or <tt>" "</tt> (space — unchanged) prefix, this format +files A and B with a single column that has <code>-</code> (minus — appears in A but removed in B), <code>+</code> (plus — missing in A but +added to B), or <code>" "</code> (space — unchanged) prefix, this format compares two or more files file1, file2,… with one file X, and shows how X differs from each of fileN. One column for each of fileN is prepended to the output line to note how X’s line is different from it.</p></div> -<div class="paragraph"><p>A <tt>-</tt> character in the column N means that the line appears in -fileN but it does not appear in the result. A <tt>+</tt> character +<div class="paragraph"><p>A <code>-</code> character in the column N means that the line appears in +fileN but it does not appear in the result. A <code>+</code> character in the column N means that the line appears in the result, and fileN does not have that line (in other words, the line was added, from the point of view of that parent).</p></div> <div class="paragraph"><p>In the above example output, the function signature was changed -from both files (hence two <tt>-</tt> removals from both file1 and -file2, plus <tt>++</tt> to mean one line that was added does not appear +from both files (hence two <code>-</code> removals from both file1 and +file2, plus <code>++</code> to mean one line that was added does not appear in either file1 nor file2). Also eight other lines are the same -from file1 but do not appear in file2 (hence prefixed with <tt>+</tt>).</p></div> -<div class="paragraph"><p>When shown by <tt>git diff-tree -c</tt>, it compares the parents of a +from file1 but do not appear in file2 (hence prefixed with <code>+</code>).</p></div> +<div class="paragraph"><p>When shown by <code>git diff-tree -c</code>, it compares the parents of a merge commit with the merge result (i.e. file1..fileN are the -parents). When shown by <tt>git diff-files -c</tt>, it compares the +parents). When shown by <code>git diff-files -c</code>, it compares the two unresolved merge parents with the working tree file (i.e. file1 is stage 2 aka "our version", file2 is stage 3 aka "their version").</p></div> </div> +</div> +<div class="sect1"> <h2 id="_other_diff_formats">other diff formats</h2> <div class="sectionbody"> -<div class="paragraph"><p>The <tt>--summary</tt> option describes newly added, deleted, renamed and -copied files. The <tt>--stat</tt> option adds diffstat(1) graph to the +<div class="paragraph"><p>The <code>--summary</code> option describes newly added, deleted, renamed and +copied files. The <code>--stat</code> option adds diffstat(1) graph to the output. These options can be combined with other options, such as -<tt>-p</tt>, and are meant for human consumption.</p></div> -<div class="paragraph"><p>When showing a change that involves a rename or a copy, <tt>--stat</tt> output +<code>-p</code>, and are meant for human consumption.</p></div> +<div class="paragraph"><p>When showing a change that involves a rename or a copy, <code>--stat</code> output formats the pathnames compactly by combining common prefix and suffix of -the pathnames. For example, a change that moves <tt>arch/i386/Makefile</tt> to -<tt>arch/x86/Makefile</tt> while modifying 4 lines will be shown like this:</p></div> +the pathnames. For example, a change that moves <code>arch/i386/Makefile</code> to +<code>arch/x86/Makefile</code> while modifying 4 lines will be shown like this:</p></div> <div class="listingblock"> <div class="content"> -<pre><tt>arch/{i386 => x86}/Makefile | 4 +--</tt></pre> +<pre><code>arch/{i386 => x86}/Makefile | 4 +--</code></pre> </div></div> -<div class="paragraph"><p>The <tt>--numstat</tt> option gives the diffstat(1) information but is designed -for easier machine consumption. An entry in <tt>--numstat</tt> output looks +<div class="paragraph"><p>The <code>--numstat</code> option gives the diffstat(1) information but is designed +for easier machine consumption. An entry in <code>--numstat</code> output looks like this:</p></div> <div class="listingblock"> <div class="content"> -<pre><tt>1 2 README -3 1 arch/{i386 => x86}/Makefile</tt></pre> +<pre><code>1 2 README +3 1 arch/{i386 => x86}/Makefile</code></pre> </div></div> <div class="paragraph"><p>That is, from left to right:</p></div> <div class="olist arabic"><ol class="arabic"> @@ -1886,11 +2073,11 @@ </p> </li> </ol></div> -<div class="paragraph"><p>When <tt>-z</tt> output option is in effect, the output is formatted this way:</p></div> +<div class="paragraph"><p>When <code>-z</code> output option is in effect, the output is formatted this way:</p></div> <div class="listingblock"> <div class="content"> -<pre><tt>1 2 README NUL -3 1 NUL arch/i386/Makefile NUL arch/x86/Makefile NUL</tt></pre> +<pre><code>1 2 README NUL +3 1 NUL arch/i386/Makefile NUL arch/x86/Makefile NUL</code></pre> </div></div> <div class="paragraph"><p>That is:</p></div> <div class="olist arabic"><ol class="arabic"> @@ -1940,12 +2127,14 @@ </p> </li> </ol></div> -<div class="paragraph"><p>The extra <tt>NUL</tt> before the preimage path in renamed case is to allow +<div class="paragraph"><p>The extra <code>NUL</code> before the preimage path in renamed case is to allow scripts that read the output to tell if the current record being read is a single-path record or a rename/copy record without reading ahead. -After reading added and deleted lines, reading up to <tt>NUL</tt> would yield -the pathname, but if that is <tt>NUL</tt>, the record will show two paths.</p></div> +After reading added and deleted lines, reading up to <code>NUL</code> would yield +the pathname, but if that is <code>NUL</code>, the record will show two paths.</p></div> </div> +</div> +<div class="sect1"> <h2 id="_operating_modes">Operating Modes</h2> <div class="sectionbody"> <div class="paragraph"><p>You can choose whether you want to trust the index file entirely @@ -1953,13 +2142,15 @@ that don’t match the stat state as being "tentatively changed". Both of these operations are very useful indeed.</p></div> </div> +</div> +<div class="sect1"> <h2 id="_cached_mode">Cached Mode</h2> <div class="sectionbody"> <div class="paragraph"><p>If <em>--cached</em> is specified, it allows you to ask:</p></div> <div class="literalblock"> <div class="content"> -<pre><tt>show me the differences between HEAD and the current index -contents (the ones I'd write using 'git write-tree')</tt></pre> +<pre><code>show me the differences between HEAD and the current index +contents (the ones I'd write using 'git write-tree')</code></pre> </div></div> <div class="paragraph"><p>For example, let’s say that you have worked on your working directory, updated some files in the index and are ready to commit. You want to see exactly @@ -1967,26 +2158,28 @@ object and compare it that way, and to do that, you just do</p></div> <div class="literalblock"> <div class="content"> -<pre><tt>git diff-index --cached HEAD</tt></pre> +<pre><code>git diff-index --cached HEAD</code></pre> </div></div> -<div class="paragraph"><p>Example: let’s say I had renamed <tt>commit.c</tt> to <tt>git-commit.c</tt>, and I had -done an <tt>update-index</tt> to make that effective in the index file. -<tt>git diff-files</tt> wouldn’t show anything at all, since the index file +<div class="paragraph"><p>Example: let’s say I had renamed <code>commit.c</code> to <code>git-commit.c</code>, and I had +done an <code>update-index</code> to make that effective in the index file. +<code>git diff-files</code> wouldn’t show anything at all, since the index file matches my working directory. But doing a <em>git diff-index</em> does:</p></div> <div class="literalblock"> <div class="content"> -<pre><tt>torvalds@ppc970:~/git> git diff-index --cached HEAD +<pre><code>torvalds@ppc970:~/git> git diff-index --cached HEAD -100644 blob 4161aecc6700a2eb579e842af0b7f22b98443f74 commit.c -+100644 blob 4161aecc6700a2eb579e842af0b7f22b98443f74 git-commit.c</tt></pre> ++100644 blob 4161aecc6700a2eb579e842af0b7f22b98443f74 git-commit.c</code></pre> </div></div> <div class="paragraph"><p>You can see easily that the above is a rename.</p></div> -<div class="paragraph"><p>In fact, <tt>git diff-index --cached</tt> <strong>should</strong> always be entirely equivalent to +<div class="paragraph"><p>In fact, <code>git diff-index --cached</code> <strong>should</strong> always be entirely equivalent to actually doing a <em>git write-tree</em> and comparing that. Except this one is much nicer for the case where you just want to check where you are.</p></div> -<div class="paragraph"><p>So doing a <tt>git diff-index --cached</tt> is basically very useful when you are +<div class="paragraph"><p>So doing a <code>git diff-index --cached</code> is basically very useful when you are asking yourself "what have I already marked for being committed, and what’s the difference to a previous tree".</p></div> </div> +</div> +<div class="sect1"> <h2 id="_non_cached_mode">Non-cached Mode</h2> <div class="sectionbody"> <div class="paragraph"><p>The "non-cached" mode takes a different approach, and is potentially @@ -1995,23 +2188,23 @@ The non-cached version asks the question:</p></div> <div class="literalblock"> <div class="content"> -<pre><tt>show me the differences between HEAD and the currently checked out -tree - index contents _and_ files that aren't up-to-date</tt></pre> +<pre><code>show me the differences between HEAD and the currently checked out +tree - index contents _and_ files that aren't up-to-date</code></pre> </div></div> <div class="paragraph"><p>which is obviously a very useful question too, since that tells you what you <strong>could</strong> commit. Again, the output matches the <em>git diff-tree -r</em> output to a tee, but with a twist.</p></div> <div class="paragraph"><p>The twist is that if some file doesn’t match the index, we don’t have a backing store thing for it, and we use the magic "all-zero" sha1 to -show that. So let’s say that you have edited <tt>kernel/sched.c</tt>, but +show that. So let’s say that you have edited <code>kernel/sched.c</code>, but have not actually done a <em>git update-index</em> on it yet - there is no "object" associated with the new state, and you get:</p></div> <div class="literalblock"> <div class="content"> -<pre><tt>torvalds@ppc970:~/v2.6/linux> git diff-index --abbrev HEAD -:100644 100664 7476bb... 000000... kernel/sched.c</tt></pre> +<pre><code>torvalds@ppc970:~/v2.6/linux> git diff-index --abbrev HEAD +:100644 100664 7476bb... 000000... kernel/sched.c</code></pre> </div></div> -<div class="paragraph"><p>i.e., it shows that the tree has changed, and that <tt>kernel/sched.c</tt> has is +<div class="paragraph"><p>i.e., it shows that the tree has changed, and that <code>kernel/sched.c</code> has is not up-to-date and may contain new stuff. The all-zero sha1 means that to get the real diff, you need to look at the object in the working directory directly rather than do an object-to-object diff.</p></div> @@ -2022,7 +2215,7 @@ </td> <td class="content">As with other commands of this type, <em>git diff-index</em> does not actually look at the contents of the file at all. So maybe -<tt>kernel/sched.c</tt> hasn’t actually changed, and it’s just that you +<code>kernel/sched.c</code> hasn’t actually changed, and it’s just that you touched it. In either case, it’s a note that you need to <em>git update-index</em> it to make the index be in sync.</td> </tr></table> @@ -2040,15 +2233,18 @@ </tr></table> </div> </div> +</div> +<div class="sect1"> <h2 id="_git">GIT</h2> <div class="sectionbody"> <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div> </div> </div> +</div> <div id="footnotes"><hr /></div> <div id="footer"> <div id="footer-text"> -Last updated 2011-11-15 13:45:02 PDT +Last updated 2011-11-15 13:45:02 PST </div> </div> </body> diff --git a/git-diff-tree.html b/git-diff-tree.html index 8c8e66a..facc550 100644 --- a/git-diff-tree.html +++ b/git-diff-tree.html
@@ -2,15 +2,25 @@ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> <head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> -<meta name="generator" content="AsciiDoc 8.5.2" /> +<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" /> +<meta name="generator" content="AsciiDoc 8.6.8" /> <title>git-diff-tree(1)</title> <style type="text/css"> -/* Debug borders */ -p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 { -/* - border: 1px solid red; -*/ +/* Shared CSS for AsciiDoc xhtml11 and html5 backends */ + +/* Default font. */ +body { + font-family: Georgia,serif; +} + +/* Title font. */ +h1, h2, h3, h4, h5, h6, +div.title, caption.title, +thead, p.table.header, +#toctitle, +#author, #revnumber, #revdate, #revremark, +#footer { + font-family: Arial,Helvetica,sans-serif; } body { @@ -35,13 +45,8 @@ color: #083194; } -tt { - color: navy; -} - h1, h2, h3, h4, h5, h6 { color: #527bbd; - font-family: sans-serif; margin-top: 1.2em; margin-bottom: 0.5em; line-height: 1.3; @@ -59,9 +64,11 @@ h3 + * { clear: left; } +h5 { + font-size: 1.0em; +} div.sectionbody { - font-family: serif; margin-left: 0; } @@ -77,45 +84,48 @@ ul, ol, li > p { margin-top: 0; } +ul > li { color: #aaa; } +ul > li > * { color: black; } -pre { +.monospaced, code, pre { + font-family: "Courier New", Courier, monospace; + font-size: inherit; + color: navy; padding: 0; margin: 0; } -span#author { + +#author { color: #527bbd; - font-family: sans-serif; font-weight: bold; font-size: 1.1em; } -span#email { +#email { } -span#revnumber, span#revdate, span#revremark { - font-family: sans-serif; +#revnumber, #revdate, #revremark { } -div#footer { - font-family: sans-serif; +#footer { font-size: small; border-top: 2px solid silver; padding-top: 0.5em; margin-top: 4.0em; } -div#footer-text { +#footer-text { float: left; padding-bottom: 0.5em; } -div#footer-badges { +#footer-badges { float: right; padding-bottom: 0.5em; } -div#preamble { +#preamble { margin-top: 1.5em; margin-bottom: 1.5em; } -div.tableblock, div.imageblock, div.exampleblock, div.verseblock, +div.imageblock, div.exampleblock, div.verseblock, div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock, div.admonitionblock { margin-top: 1.0em; @@ -135,7 +145,6 @@ /* Block element titles. */ div.title, caption.title { color: #527bbd; - font-family: sans-serif; font-weight: bold; text-align: left; margin-top: 1.0em; @@ -157,13 +166,15 @@ div.sidebarblock > div.content { background: #ffffee; - border: 1px solid silver; + border: 1px solid #dddddd; + border-left: 4px solid #f0f0f0; padding: 0.5em; } div.listingblock > div.content { - border: 1px solid silver; - background: #f4f4f4; + border: 1px solid #dddddd; + border-left: 5px solid #f0f0f0; + background: #f8f8f8; padding: 0.5em; } @@ -171,8 +182,8 @@ padding-left: 1.0em; margin-left: 1.0em; margin-right: 10%; - border-left: 5px solid #dddddd; - color: #777777; + border-left: 5px solid #f0f0f0; + color: #888; } div.quoteblock > div.attribution { @@ -180,8 +191,9 @@ text-align: right; } -div.verseblock > div.content { - white-space: pre; +div.verseblock > pre.content { + font-family: inherit; + font-size: inherit; } div.verseblock > div.attribution { padding-top: 0.75em; @@ -254,35 +266,12 @@ margin-bottom: 0.1em; } -div.tableblock > table { - border: 3px solid #527bbd; -} -thead, p.table.header { - font-family: sans-serif; - font-weight: bold; -} tfoot { font-weight: bold; } td > div.verse { white-space: pre; } -p.table { - margin-top: 0; -} -/* Because the table frame attribute is overriden by CSS in most browsers. */ -div.tableblock > table[frame="void"] { - border-style: none; -} -div.tableblock > table[frame="hsides"] { - border-left-style: none; - border-right-style: none; -} -div.tableblock > table[frame="vsides"] { - border-top-style: none; - border-bottom-style: none; -} - div.hdlist { margin-top: 0.8em; @@ -339,25 +328,32 @@ min-width: 100px; } - -@media print { - div#footer-badges { display: none; } +div.colist td { + padding-right: 0.5em; + padding-bottom: 0.3em; + vertical-align: top; +} +div.colist td img { + margin-top: 0.3em; } -div#toc { +@media print { + #footer-badges { display: none; } +} + +#toc { margin-bottom: 2.5em; } -div#toctitle { +#toctitle { color: #527bbd; - font-family: sans-serif; font-size: 1.1em; font-weight: bold; margin-top: 1.0em; margin-bottom: 0.1em; } -div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 { +div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 { margin-top: 0; margin-bottom: 0; } @@ -373,69 +369,173 @@ margin-left: 6em; font-size: 0.9em; } -/* Overrides for manpage documents */ -h1 { + +span.aqua { color: aqua; } +span.black { color: black; } +span.blue { color: blue; } +span.fuchsia { color: fuchsia; } +span.gray { color: gray; } +span.green { color: green; } +span.lime { color: lime; } +span.maroon { color: maroon; } +span.navy { color: navy; } +span.olive { color: olive; } +span.purple { color: purple; } +span.red { color: red; } +span.silver { color: silver; } +span.teal { color: teal; } +span.white { color: white; } +span.yellow { color: yellow; } + +span.aqua-background { background: aqua; } +span.black-background { background: black; } +span.blue-background { background: blue; } +span.fuchsia-background { background: fuchsia; } +span.gray-background { background: gray; } +span.green-background { background: green; } +span.lime-background { background: lime; } +span.maroon-background { background: maroon; } +span.navy-background { background: navy; } +span.olive-background { background: olive; } +span.purple-background { background: purple; } +span.red-background { background: red; } +span.silver-background { background: silver; } +span.teal-background { background: teal; } +span.white-background { background: white; } +span.yellow-background { background: yellow; } + +span.big { font-size: 2em; } +span.small { font-size: 0.6em; } + +span.underline { text-decoration: underline; } +span.overline { text-decoration: overline; } +span.line-through { text-decoration: line-through; } + +div.unbreakable { page-break-inside: avoid; } + + +/* + * xhtml11 specific + * + * */ + +div.tableblock { + margin-top: 1.0em; + margin-bottom: 1.5em; +} +div.tableblock > table { + border: 3px solid #527bbd; +} +thead, p.table.header { + font-weight: bold; + color: #527bbd; +} +p.table { + margin-top: 0; +} +/* Because the table frame attribute is overriden by CSS in most browsers. */ +div.tableblock > table[frame="void"] { + border-style: none; +} +div.tableblock > table[frame="hsides"] { + border-left-style: none; + border-right-style: none; +} +div.tableblock > table[frame="vsides"] { + border-top-style: none; + border-bottom-style: none; +} + + +/* + * html5 specific + * + * */ + +table.tableblock { + margin-top: 1.0em; + margin-bottom: 1.5em; +} +thead, p.tableblock.header { + font-weight: bold; + color: #527bbd; +} +p.tableblock { + margin-top: 0; +} +table.tableblock { + border-width: 3px; + border-spacing: 0px; + border-style: solid; + border-color: #527bbd; + border-collapse: collapse; +} +th.tableblock, td.tableblock { + border-width: 1px; + padding: 4px; + border-style: solid; + border-color: #527bbd; +} + +table.tableblock.frame-topbot { + border-left-style: hidden; + border-right-style: hidden; +} +table.tableblock.frame-sides { + border-top-style: hidden; + border-bottom-style: hidden; +} +table.tableblock.frame-none { + border-style: hidden; +} + +th.tableblock.halign-left, td.tableblock.halign-left { + text-align: left; +} +th.tableblock.halign-center, td.tableblock.halign-center { + text-align: center; +} +th.tableblock.halign-right, td.tableblock.halign-right { + text-align: right; +} + +th.tableblock.valign-top, td.tableblock.valign-top { + vertical-align: top; +} +th.tableblock.valign-middle, td.tableblock.valign-middle { + vertical-align: middle; +} +th.tableblock.valign-bottom, td.tableblock.valign-bottom { + vertical-align: bottom; +} + + +/* + * manpage specific + * + * */ + +body.manpage h1 { padding-top: 0.5em; padding-bottom: 0.5em; border-top: 2px solid silver; border-bottom: 2px solid silver; } -h2 { +body.manpage h2 { border-style: none; } -div.sectionbody { - margin-left: 5%; +body.manpage div.sectionbody { + margin-left: 3em; } @media print { - div#toc { display: none; } + body.manpage div#toc { display: none; } } -/* Workarounds for IE6's broken and incomplete CSS2. */ -div.sidebar-content { - background: #ffffee; - border: 1px solid silver; - padding: 0.5em; -} -div.sidebar-title, div.image-title { - color: #527bbd; - font-family: sans-serif; - font-weight: bold; - margin-top: 0.0em; - margin-bottom: 0.5em; -} - -div.listingblock div.content { - border: 1px solid silver; - background: #f4f4f4; - padding: 0.5em; -} - -div.quoteblock-attribution { - padding-top: 0.5em; - text-align: right; -} - -div.verseblock-content { - white-space: pre; -} -div.verseblock-attribution { - padding-top: 0.75em; - text-align: left; -} - -div.exampleblock-content { - border-left: 3px solid #dddddd; - padding-left: 0.5em; -} - -/* IE6 sets dynamically generated links as visited. */ -div#toc a:visited { color: blue; } </style> <script type="text/javascript"> /*<+'])'); + var re = new RegExp('[hH]([1-'+(toclevels+1)+'])'); // Function that scans the DOM tree for header elements (the DOM2 // nodeIterator API would be a better technique but not supported by all // browsers). @@ -497,6 +597,25 @@ } var toc = document.getElementById("toc"); + if (!toc) { + return; + } + + // Delete existing TOC entries in case we're reloading the TOC. + var tocEntriesToRemove = []; + var i; + for (i = 0; i < toc.childNodes.length; i++) { + var entry = toc.childNodes[i]; + if (entry.nodeName.toLowerCase() == 'div' + && entry.getAttribute("class") + && entry.getAttribute("class").match(/^toclevel/)) + tocEntriesToRemove.push(entry); + } + for (i = 0; i < tocEntriesToRemove.length; i++) { + toc.removeChild(tocEntriesToRemove[i]); + } + + // Rebuild TOC entries. var entries = tocEntries(document.getElementById("content"), toclevels); for (var i = 0; i < entries.length; ++i) { var entry = entries[i]; @@ -524,24 +643,44 @@ */ footnotes: function () { - var cont = document.getElementById("content"); + // Delete existing footnote entries in case we're reloading the footnodes. + var i; var noteholder = document.getElementById("footnotes"); + if (!noteholder) { + return; + } + var entriesToRemove = []; + for (i = 0; i < noteholder.childNodes.length; i++) { + var entry = noteholder.childNodes[i]; + if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote") + entriesToRemove.push(entry); + } + for (i = 0; i < entriesToRemove.length; i++) { + noteholder.removeChild(entriesToRemove[i]); + } + + // Rebuild footnote entries. + var cont = document.getElementById("content"); var spans = cont.getElementsByTagName("span"); var refs = {}; var n = 0; for (i=0; i<spans.length; i++) { if (spans[i].className == "footnote") { n++; - // Use [\s\S] in place of . so multi-line matches work. - // Because JavaScript has no s (dotall) regex flag. - note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1]; + var note = spans[i].getAttribute("data-note"); + if (!note) { + // Use [\s\S] in place of . so multi-line matches work. + // Because JavaScript has no s (dotall) regex flag. + note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1]; + spans[i].innerHTML = + "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n + + "' title='View footnote' class='footnote'>" + n + "</a>]"; + spans[i].setAttribute("data-note", note); + } noteholder.innerHTML += "<div class='footnote' id='_footnote_" + n + "'>" + "<a href='#_footnoteref_" + n + "' title='Return to text'>" + n + "</a>. " + note + "</div>"; - spans[i].innerHTML = - "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n + - "' title='View footnote' class='footnote'>" + n + "</a>]"; var id =spans[i].getAttribute("id"); if (id != null) refs["#"+id] = n; } @@ -561,13 +700,36 @@ } } } +}, + +install: function(toclevels) { + var timerId; + + function reinstall() { + asciidoc.footnotes(); + if (toclevels) { + asciidoc.toc(toclevels); + } + } + + function reinstallAndRemoveTimer() { + clearInterval(timerId); + reinstall(); + } + + timerId = setInterval(reinstall, 500); + if (document.addEventListener) + document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false); + else + window.onload = reinstallAndRemoveTimer; } } +asciidoc.install(); /*]]>*/ </script> </head> -<body> +<body class="manpage"> <div id="header"> <h1> git-diff-tree(1) Manual Page @@ -580,15 +742,18 @@ </div> </div> <div id="content"> +<div class="sect1"> <h2 id="_synopsis">SYNOPSIS</h2> <div class="sectionbody"> <div class="verseblock"> -<div class="verseblock-content"><em>git diff-tree</em> [--stdin] [-m] [-s] [-v] [--no-commit-id] [--pretty] +<pre class="content"><em>git diff-tree</em> [--stdin] [-m] [-s] [-v] [--no-commit-id] [--pretty] [-t] [-r] [-c | --cc] [--root] [<common diff options>] - <tree-ish> [<tree-ish>] [<path>…]</div> -<div class="verseblock-attribution"> + <tree-ish> [<tree-ish>] [<path>…]</pre> +<div class="attribution"> </div></div> </div> +</div> +<div class="sect1"> <h2 id="_description">DESCRIPTION</h2> <div class="sectionbody"> <div class="paragraph"><p>Compares the content and mode of the blobs found via two tree objects.</p></div> @@ -596,6 +761,8 @@ (see --stdin below).</p></div> <div class="paragraph"><p>Note that <em>git diff-tree</em> can use the tree encapsulated in a commit object.</p></div> </div> +</div> +<div class="sect1"> <h2 id="_options">OPTIONS</h2> <div class="sectionbody"> <div class="dlist"><dl> @@ -624,7 +791,7 @@ <p> Generate diffs with <n> lines of context instead of the usual three. - Implies <tt>-p</tt>. + Implies <code>-p</code>. </p> </dd> <dt class="hdlist1"> @@ -641,7 +808,7 @@ </dt> <dd> <p> - Synonym for <tt>-p --raw</tt>. + Synonym for <code>-p --raw</code>. </p> </dd> <dt class="hdlist1"> @@ -678,29 +845,29 @@ will be used for the filename part, and the rest for the graph part. Maximum width defaults to terminal width, or 80 columns if not connected to a terminal, and can be overridden by - <tt><width></tt>. The width of the filename part can be limited by - giving another width <tt><name-width></tt> after a comma. The width + <code><width></code>. The width of the filename part can be limited by + giving another width <code><name-width></code> after a comma. The width of the graph part can be limited by using - <tt>--stat-graph-width=<width></tt> (affects all commands generating - a stat graph) or by setting <tt>diff.statGraphWidth=<width></tt> - (does not affect <tt>git format-patch</tt>). - By giving a third parameter <tt><count></tt>, you can limit the - output to the first <tt><count></tt> lines, followed by <tt>...</tt> if + <code>--stat-graph-width=<width></code> (affects all commands generating + a stat graph) or by setting <code>diff.statGraphWidth=<width></code> + (does not affect <code>git format-patch</code>). + By giving a third parameter <code><count></code>, you can limit the + output to the first <code><count></code> lines, followed by <code>...</code> if there are more. </p> -<div class="paragraph"><p>These parameters can also be set individually with <tt>--stat-width=<width></tt>, -<tt>--stat-name-width=<name-width></tt> and <tt>--stat-count=<count></tt>.</p></div> +<div class="paragraph"><p>These parameters can also be set individually with <code>--stat-width=<width></code>, +<code>--stat-name-width=<name-width></code> and <code>--stat-count=<count></code>.</p></div> </dd> <dt class="hdlist1"> --numstat </dt> <dd> <p> - Similar to <tt>--stat</tt>, but shows number of added and + Similar to <code>--stat</code>, but shows number of added and deleted lines in decimal notation and pathname without abbreviation, to make it more machine friendly. For - binary files, outputs two <tt>-</tt> instead of saying - <tt>0 0</tt>. + binary files, outputs two <code>-</code> instead of saying + <code>0 0</code>. </p> </dd> <dt class="hdlist1"> @@ -708,7 +875,7 @@ </dt> <dd> <p> - Output only the last line of the <tt>--stat</tt> format containing total + Output only the last line of the <code>--stat</code> format containing total number of modified files, as well as number of added and deleted lines. </p> @@ -719,15 +886,17 @@ <dd> <p> Output the distribution of relative amount of changes for each - sub-directory. The behavior of <tt>--dirstat</tt> can be customized by + sub-directory. The behavior of <code>--dirstat</code> can be customized by passing it a comma separated list of parameters. - The defaults are controlled by the <tt>diff.dirstat</tt> configuration + The defaults are controlled by the <code>diff.dirstat</code> configuration variable (see <a href="git-config.html">git-config(1)</a>). The following parameters are available: </p> +<div class="openblock"> +<div class="content"> <div class="dlist"><dl> <dt class="hdlist1"> -<tt>changes</tt> +<code>changes</code> </dt> <dd> <p> @@ -739,39 +908,39 @@ </p> </dd> <dt class="hdlist1"> -<tt>lines</tt> +<code>lines</code> </dt> <dd> <p> Compute the dirstat numbers by doing the regular line-based diff analysis, and summing the removed/added line counts. (For binary files, count 64-byte chunks instead, since binary files have no - natural concept of lines). This is a more expensive <tt>--dirstat</tt> - behavior than the <tt>changes</tt> behavior, but it does count rearranged + natural concept of lines). This is a more expensive <code>--dirstat</code> + behavior than the <code>changes</code> behavior, but it does count rearranged lines within a file as much as other changes. The resulting output - is consistent with what you get from the other <tt>--*stat</tt> options. + is consistent with what you get from the other <code>--*stat</code> options. </p> </dd> <dt class="hdlist1"> -<tt>files</tt> +<code>files</code> </dt> <dd> <p> Compute the dirstat numbers by counting the number of files changed. Each changed file counts equally in the dirstat analysis. This is - the computationally cheapest <tt>--dirstat</tt> behavior, since it does + the computationally cheapest <code>--dirstat</code> behavior, since it does not have to look at the file contents at all. </p> </dd> <dt class="hdlist1"> -<tt>cumulative</tt> +<code>cumulative</code> </dt> <dd> <p> Count changes in a child directory for the parent directory as well. - Note that when using <tt>cumulative</tt>, the sum of the percentages + Note that when using <code>cumulative</code>, the sum of the percentages reported may exceed 100%. The default (non-cumulative) behavior can - be specified with the <tt>noncumulative</tt> parameter. + be specified with the <code>noncumulative</code> parameter. </p> </dd> <dt class="hdlist1"> @@ -785,10 +954,11 @@ </p> </dd> </dl></div> +</div></div> <div class="paragraph"><p>Example: The following will count changed files, while ignoring directories with less than 10% of the total amount of changed files, and accumulating child directory counts in the parent directories: -<tt>--dirstat=files,10,cumulative</tt>.</p></div> +<code>--dirstat=files,10,cumulative</code>.</p></div> </dd> <dt class="hdlist1"> --summary @@ -804,7 +974,7 @@ </dt> <dd> <p> - Synonym for <tt>-p --stat</tt>. + Synonym for <code>-p --stat</code>. </p> </dd> <dt class="hdlist1"> @@ -812,11 +982,11 @@ </dt> <dd> <p> - When <tt>--raw</tt>, <tt>--numstat</tt>, <tt>--name-only</tt> or <tt>--name-status</tt> has been + When <code>--raw</code>, <code>--numstat</code>, <code>--name-only</code> or <code>--name-status</code> has been given, do not munge pathnames and use NULs as output field terminators. </p> <div class="paragraph"><p>Without this option, each pathname output will have TAB, LF, double quotes, -and backslash characters replaced with <tt>\t</tt>, <tt>\n</tt>, <tt>\"</tt>, and <tt>\\</tt>, +and backslash characters replaced with <code>\t</code>, <code>\n</code>, <code>\"</code>, and <code>\\</code>, respectively, and the pathname will be enclosed in double quotes if any of those replacements occurred.</p></div> </dd> @@ -834,7 +1004,7 @@ <dd> <p> Show only names and status of changed files. See the description - of the <tt>--diff-filter</tt> option on what the status letters mean. + of the <code>--diff-filter</code> option on what the status letters mean. </p> </dd> <dt class="hdlist1"> @@ -842,13 +1012,13 @@ </dt> <dd> <p> - Specify how differences in submodules are shown. When <tt>--submodule</tt> - or <tt>--submodule=log</tt> is given, the <em>log</em> format is used. This format lists - the commits in the range like <a href="git-submodule.html">git-submodule(1)</a> <tt>summary</tt> does. - Omitting the <tt>--submodule</tt> option or specifying <tt>--submodule=short</tt>, + Specify how differences in submodules are shown. When <code>--submodule</code> + or <code>--submodule=log</code> is given, the <em>log</em> format is used. This format lists + the commits in the range like <a href="git-submodule.html">git-submodule(1)</a> <code>summary</code> does. + Omitting the <code>--submodule</code> option or specifying <code>--submodule=short</code>, uses the <em>short</em> format. This format just shows the names of the commits at the beginning and end of the range. Can be tweaked via the - <tt>diff.submodule</tt> configuration variable. + <code>diff.submodule</code> configuration variable. </p> </dd> <dt class="hdlist1"> @@ -857,8 +1027,8 @@ <dd> <p> Show colored diff. - The value must be <tt>always</tt> (the default for <tt><when></tt>), <tt>never</tt>, or <tt>auto</tt>. - The default value is <tt>never</tt>. + The value must be <code>always</code> (the default for <code><when></code>), <code>never</code>, or <code>auto</code>. + The default value is <code>never</code>. </p> </dd> <dt class="hdlist1"> @@ -867,7 +1037,7 @@ <dd> <p> Turn off colored diff. - It is the same as <tt>--color=never</tt>. + It is the same as <code>--color=never</code>. </p> </dd> <dt class="hdlist1"> @@ -877,16 +1047,18 @@ <p> Show a word diff, using the <mode> to delimit changed words. By default, words are delimited by whitespace; see - <tt>--word-diff-regex</tt> below. The <mode> defaults to <em>plain</em>, and + <code>--word-diff-regex</code> below. The <mode> defaults to <em>plain</em>, and must be one of: </p> +<div class="openblock"> +<div class="content"> <div class="dlist"><dl> <dt class="hdlist1"> color </dt> <dd> <p> - Highlight changed words using only colors. Implies <tt>--color</tt>. + Highlight changed words using only colors. Implies <code>--color</code>. </p> </dd> <dt class="hdlist1"> @@ -894,7 +1066,7 @@ </dt> <dd> <p> - Show words as <tt>[-removed-]</tt> and <tt>{+added+}</tt>. Makes no + Show words as <code>[-removed-]</code> and <code>{+added+}</code>. Makes no attempts to escape the delimiters if they appear in the input, so the output may be ambiguous. </p> @@ -906,10 +1078,10 @@ <p> Use a special line-based format intended for script consumption. Added/removed/unchanged runs are printed in the - usual unified diff format, starting with a <tt>+</tt>/<tt>-</tt>/` ` + usual unified diff format, starting with a <code>+</code>/<code>-</code>/` ` character at the beginning of the line and extending to the end of the line. Newlines in the input are represented by a - tilde <tt>~</tt> on a line of its own. + tilde <code>~</code> on a line of its own. </p> </dd> <dt class="hdlist1"> @@ -921,6 +1093,7 @@ </p> </dd> </dl></div> +</div></div> <div class="paragraph"><p>Note that despite the name of the first mode, color is used to highlight the changed parts in all modes if enabled.</p></div> </dd> @@ -931,12 +1104,12 @@ <p> Use <regex> to decide what a word is, instead of considering runs of non-whitespace to be a word. Also implies - <tt>--word-diff</tt> unless it was already enabled. + <code>--word-diff</code> unless it was already enabled. </p> <div class="paragraph"><p>Every non-overlapping match of the <regex> is considered a word. Anything between these matches is considered whitespace and ignored(!) for the purposes of finding -differences. You may want to append <tt>|[^[:space:]]</tt> to your regular +differences. You may want to append <code>|[^[:space:]]</code> to your regular expression to make sure that it matches all non-whitespace characters. A match that contains a newline is silently truncated(!) at the newline.</p></div> @@ -950,8 +1123,8 @@ </dt> <dd> <p> - Equivalent to <tt>--word-diff=color</tt> plus (if a regex was - specified) <tt>--word-diff-regex=<regex></tt>. + Equivalent to <code>--word-diff=color</code> plus (if a regex was + specified) <code>--word-diff-regex=<regex></code>. </p> </dd> <dt class="hdlist1"> @@ -969,7 +1142,7 @@ <dd> <p> Warn if changes introduce whitespace errors. What are - considered whitespace errors is controlled by <tt>core.whitespace</tt> + considered whitespace errors is controlled by <code>core.whitespace</code> configuration. By default, trailing whitespaces (including lines that solely consist of whitespaces) and a space character that is immediately followed by a tab character inside the @@ -993,8 +1166,8 @@ </dt> <dd> <p> - In addition to <tt>--full-index</tt>, output a binary diff that - can be applied with <tt>git-apply</tt>. + In addition to <code>--full-index</code>, output a binary diff that + can be applied with <code>git-apply</code>. </p> </dd> <dt class="hdlist1"> @@ -1005,9 +1178,9 @@ Instead of showing the full 40-byte hexadecimal object name in diff-raw format output and diff-tree header lines, show only a partial prefix. This is - independent of the <tt>--full-index</tt> option above, which controls + independent of the <code>--full-index</code> option above, which controls the diff-patch output format. Non default number of - digits can be specified with <tt>--abbrev=<n></tt>. + digits can be specified with <code>--abbrev=<n></code>. </p> </dd> <dt class="hdlist1"> @@ -1025,15 +1198,15 @@ not as a series of deletion and insertion mixed together with a very few lines that happen to match textually as the context, but as a single deletion of everything old followed by a single insertion of -everything new, and the number <tt>m</tt> controls this aspect of the -B -option (defaults to 60%). <tt>-B/70%</tt> specifies that less than 30% of the +everything new, and the number <code>m</code> controls this aspect of the -B +option (defaults to 60%). <code>-B/70%</code> specifies that less than 30% of the original should remain in the result for git to consider it a total rewrite (i.e. otherwise the resulting patch will be a series of deletion and insertion mixed together with context lines).</p></div> <div class="paragraph"><p>When used with -M, a totally-rewritten file is also considered as the source of a rename (usually -M only considers a file that disappeared -as the source of a rename), and the number <tt>n</tt> controls this aspect of -the -B option (defaults to 50%). <tt>-B20%</tt> specifies that a change with +as the source of a rename), and the number <code>n</code> controls this aspect of +the -B option (defaults to 50%). <code>-B20%</code> specifies that a change with addition and deletion compared to 20% or more of the file’s size are eligible for being picked up as a possible source of a rename to another file.</p></div> @@ -1047,11 +1220,15 @@ <dd> <p> Detect renames. - If <tt>n</tt> is specified, it is a threshold on the similarity + If <code>n</code> is specified, it is a threshold on the similarity index (i.e. amount of addition/deletions compared to the - file’s size). For example, <tt>-M90%</tt> means git should consider a + file’s size). For example, <code>-M90%</code> means git should consider a delete/add pair to be a rename if more than 90% of the file - hasn’t changed. + hasn’t changed. Without a <code>%</code> sign, the number is to be read as + a fraction, with a decimal point before it. I.e., <code>-M5</code> becomes + 0.5, and is thus the same as <code>-M50%</code>. Similarly, <code>-M05</code> is + the same as <code>-M5%</code>. To limit detection to exact renames, use + <code>-M100%</code>. </p> </dd> <dt class="hdlist1"> @@ -1062,8 +1239,8 @@ </dt> <dd> <p> - Detect copies as well as renames. See also <tt>--find-copies-harder</tt>. - If <tt>n</tt> is specified, it has the same meaning as for <tt>-M<n></tt>. + Detect copies as well as renames. See also <code>--find-copies-harder</code>. + If <code>n</code> is specified, it has the same meaning as for <code>-M<n></code>. </p> </dd> <dt class="hdlist1"> @@ -1071,13 +1248,13 @@ </dt> <dd> <p> - For performance reasons, by default, <tt>-C</tt> option finds copies only + For performance reasons, by default, <code>-C</code> option finds copies only if the original file of the copy was modified in the same changeset. This flag makes the command inspect unmodified files as candidates for the source of copy. This is a very expensive operation for large projects, so use it with caution. Giving more than one - <tt>-C</tt> option has the same effect. + <code>-C</code> option has the same effect. </p> </dd> <dt class="hdlist1"> @@ -1089,14 +1266,14 @@ <dd> <p> Omit the preimage for deletes, i.e. print only the header but not - the diff between the preimage and <tt>/dev/null</tt>. The resulting patch - is not meant to be applied with <tt>patch</tt> nor <tt>git apply</tt>; this is + the diff between the preimage and <code>/dev/null</code>. The resulting patch + is not meant to be applied with <code>patch</code> nor <code>git apply</code>; this is solely for people who want to just concentrate on reviewing the text after the change. In addition, the output obviously lack enough information to apply such a patch in reverse, even manually, hence the name of the option. </p> -<div class="paragraph"><p>When used together with <tt>-B</tt>, omit also the preimage in the deletion part +<div class="paragraph"><p>When used together with <code>-B</code>, omit also the preimage in the deletion part of a delete/create pair.</p></div> </dd> <dt class="hdlist1"> @@ -1104,7 +1281,7 @@ </dt> <dd> <p> - The <tt>-M</tt> and <tt>-C</tt> options require O(n^2) processing time where n + The <code>-M</code> and <code>-C</code> options require O(n^2) processing time where n is the number of potential rename/copy targets. This option prevents rename/copy detection from running if the number of rename/copy targets exceeds the specified @@ -1116,13 +1293,13 @@ </dt> <dd> <p> - Select only files that are Added (<tt>A</tt>), Copied (<tt>C</tt>), - Deleted (<tt>D</tt>), Modified (<tt>M</tt>), Renamed (<tt>R</tt>), have their - type (i.e. regular file, symlink, submodule, …) changed (<tt>T</tt>), - are Unmerged (<tt>U</tt>), are - Unknown (<tt>X</tt>), or have had their pairing Broken (<tt>B</tt>). + Select only files that are Added (<code>A</code>), Copied (<code>C</code>), + Deleted (<code>D</code>), Modified (<code>M</code>), Renamed (<code>R</code>), have their + type (i.e. regular file, symlink, submodule, …) changed (<code>T</code>), + are Unmerged (<code>U</code>), are + Unknown (<code>X</code>), or have had their pairing Broken (<code>B</code>). Any combination of the filter characters (including none) can be used. - When <tt>*</tt> (All-or-none) is added to the combination, all + When <code>*</code> (All-or-none) is added to the combination, all paths are selected if there is any file that matches other criteria in the comparison; if there is no file that matches other criteria, nothing is selected. @@ -1153,7 +1330,7 @@ </dt> <dd> <p> - When <tt>-S</tt> or <tt>-G</tt> finds a change, show all the changes in that + When <code>-S</code> or <code>-G</code> finds a change, show all the changes in that changeset, not just the files that contain the change in <string>. </p> @@ -1278,7 +1455,7 @@ </dt> <dd> <p> - Disable all output of the program. Implies <tt>--exit-code</tt>. + Disable all output of the program. Implies <code>--exit-code</code>. </p> </dd> <dt class="hdlist1"> @@ -1378,7 +1555,7 @@ <p> If provided, the results are limited to a subset of files matching one of these prefix strings. - i.e., file matches <tt>/^<pattern1>|<pattern2>|.../</tt> + i.e., file matches <code>/^<pattern1>|<pattern2>|.../</code> Note that this parameter does not provide any wildcard or regexp features. </p> @@ -1497,7 +1674,7 @@ <dd> <p> Show the full 40-byte hexadecimal commit object name. This negates - <tt>--abbrev-commit</tt> and those options which imply it such as + <code>--abbrev-commit</code> and those options which imply it such as "--oneline". It also overrides the <em>log.abbrevCommit</em> variable. </p> </dd> @@ -1529,15 +1706,15 @@ <p> Show the notes (see <a href="git-notes.html">git-notes(1)</a>) that annotate the commit, when showing the commit log message. This is the default - for <tt>git log</tt>, <tt>git show</tt> and <tt>git whatchanged</tt> commands when - there is no <tt>--pretty</tt>, <tt>--format</tt> nor <tt>--oneline</tt> option given + for <code>git log</code>, <code>git show</code> and <code>git whatchanged</code> commands when + there is no <code>--pretty</code>, <code>--format</code> nor <code>--oneline</code> option given on the command line. </p> <div class="paragraph"><p>By default, the notes shown are from the notes refs listed in the <em>core.notesRef</em> and <em>notes.displayRef</em> variables (or corresponding environment overrides). See <a href="git-config.html">git-config(1)</a> for more details.</p></div> <div class="paragraph"><p>With an optional <em><ref></em> argument, show this notes ref instead of the -default notes ref(s). The ref is taken to be in <tt>refs/notes/</tt> if it +default notes ref(s). The ref is taken to be in <code>refs/notes/</code> if it is not qualified.</p></div> <div class="paragraph"><p>Multiple --notes options can be combined to control which notes are being displayed. Examples: "--notes=foo" will show only notes from @@ -1549,7 +1726,7 @@ </dt> <dd> <p> - Do not show notes. This negates the above <tt>--notes</tt> option, by + Do not show notes. This negates the above <code>--notes</code> option, by resetting the list of notes refs from which notes are shown. Options are parsed in the order given on the command line, so e.g. "--notes --notes=foo --no-notes --notes=bar" will only show notes @@ -1574,7 +1751,7 @@ <dd> <p> Check the validity of a signed commit object by passing the signature - to <tt>gpg --verify</tt> and show the output. + to <code>gpg --verify</code> and show the output. </p> </dd> <dt class="hdlist1"> @@ -1627,6 +1804,8 @@ </dd> </dl></div> </div> +</div> +<div class="sect1"> <h2 id="_pretty_formats">PRETTY FORMATS</h2> <div class="sectionbody"> <div class="paragraph"><p>If the commit is a merge, and if the pretty-format @@ -1651,7 +1830,7 @@ </p> <div class="literalblock"> <div class="content"> -<pre><tt><sha1> <title line></tt></pre> +<pre><code><sha1> <title line></code></pre> </div></div> <div class="paragraph"><p>This is designed to be as compact as possible.</p></div> </li> @@ -1661,12 +1840,12 @@ </p> <div class="literalblock"> <div class="content"> -<pre><tt>commit <sha1> -Author: <author></tt></pre> +<pre><code>commit <sha1> +Author: <author></code></pre> </div></div> <div class="literalblock"> <div class="content"> -<pre><tt><title line></tt></pre> +<pre><code><title line></code></pre> </div></div> </li> <li> @@ -1675,17 +1854,17 @@ </p> <div class="literalblock"> <div class="content"> -<pre><tt>commit <sha1> +<pre><code>commit <sha1> Author: <author> -Date: <author date></tt></pre> +Date: <author date></code></pre> </div></div> <div class="literalblock"> <div class="content"> -<pre><tt><title line></tt></pre> +<pre><code><title line></code></pre> </div></div> <div class="literalblock"> <div class="content"> -<pre><tt><full commit message></tt></pre> +<pre><code><full commit message></code></pre> </div></div> </li> <li> @@ -1694,17 +1873,17 @@ </p> <div class="literalblock"> <div class="content"> -<pre><tt>commit <sha1> +<pre><code>commit <sha1> Author: <author> -Commit: <committer></tt></pre> +Commit: <committer></code></pre> </div></div> <div class="literalblock"> <div class="content"> -<pre><tt><title line></tt></pre> +<pre><code><title line></code></pre> </div></div> <div class="literalblock"> <div class="content"> -<pre><tt><full commit message></tt></pre> +<pre><code><full commit message></code></pre> </div></div> </li> <li> @@ -1713,19 +1892,19 @@ </p> <div class="literalblock"> <div class="content"> -<pre><tt>commit <sha1> +<pre><code>commit <sha1> Author: <author> AuthorDate: <author date> Commit: <committer> -CommitDate: <committer date></tt></pre> +CommitDate: <committer date></code></pre> </div></div> <div class="literalblock"> <div class="content"> -<pre><tt><title line></tt></pre> +<pre><code><title line></code></pre> </div></div> <div class="literalblock"> <div class="content"> -<pre><tt><full commit message></tt></pre> +<pre><code><full commit message></code></pre> </div></div> </li> <li> @@ -1734,14 +1913,14 @@ </p> <div class="literalblock"> <div class="content"> -<pre><tt>From <sha1> <date> +<pre><code>From <sha1> <date> From: <author> Date: <author date> -Subject: [PATCH] <title line></tt></pre> +Subject: [PATCH] <title line></code></pre> </div></div> <div class="literalblock"> <div class="content"> -<pre><tt><full commit message></tt></pre> +<pre><code><full commit message></code></pre> </div></div> </li> <li> @@ -1767,8 +1946,8 @@ would show something like this:</p></div> <div class="listingblock"> <div class="content"> -<pre><tt>The author of fe6e0ee was Junio C Hamano, 23 hours ago -The title was >>t4119: test autocomputing -p<n> for traditional diff input.<<</tt></pre> +<pre><code>The author of fe6e0ee was Junio C Hamano, 23 hours ago +The title was >>t4119: test autocomputing -p<n> for traditional diff input.<<</code></pre> </div></div> <div class="paragraph"><p>The placeholders are:</p></div> <div class="ulist"><ul> @@ -1944,12 +2123,12 @@ </li> <li> <p> -<em>%gD</em>: reflog selector, e.g., <tt>refs/stash@{1}</tt> +<em>%gD</em>: reflog selector, e.g., <code>refs/stash@{1}</code> </p> </li> <li> <p> -<em>%gd</em>: shortened reflog selector, e.g., <tt>stash@{1}</tt> +<em>%gd</em>: shortened reflog selector, e.g., <code>stash@{1}</code> </p> </li> <li> @@ -2037,16 +2216,16 @@ <div class="title">Note</div> </td> <td class="content">Some placeholders may depend on other options given to the -revision traversal engine. For example, the <tt>%g*</tt> reflog options will +revision traversal engine. For example, the <code>%g*</code> reflog options will insert an empty string unless we are traversing reflog entries (e.g., by -<tt>git log -g</tt>). The <tt>%d</tt> placeholder will use the "short" decoration -format if <tt>--decorate</tt> was not already provided on the command line.</td> +<code>git log -g</code>). The <code>%d</code> placeholder will use the "short" decoration +format if <code>--decorate</code> was not already provided on the command line.</td> </tr></table> </div> -<div class="paragraph"><p>If you add a <tt>+</tt> (plus sign) after <em>%</em> of a placeholder, a line-feed +<div class="paragraph"><p>If you add a <code>+</code> (plus sign) after <em>%</em> of a placeholder, a line-feed is inserted immediately before the expansion if and only if the placeholder expands to a non-empty string.</p></div> -<div class="paragraph"><p>If you add a <tt>-</tt> (minus sign) after <em>%</em> of a placeholder, line-feeds that +<div class="paragraph"><p>If you add a <code>-</code> (minus sign) after <em>%</em> of a placeholder, line-feeds that immediately precede the expansion are deleted if and only if the placeholder expands to an empty string.</p></div> <div class="paragraph"><p>If you add a ` ` (space) after <em>%</em> of a placeholder, a space @@ -2066,7 +2245,7 @@ For example:</p></div> <div class="listingblock"> <div class="content"> -<pre><tt>$ git log -2 --pretty=format:%h 4da45bef \ +<pre><code>$ git log -2 --pretty=format:%h 4da45bef \ | perl -pe '$_ .= " -- NO NEWLINE\n" unless /\n/' 4da45be 7134973 -- NO NEWLINE @@ -2074,49 +2253,51 @@ $ git log -2 --pretty=tformat:%h 4da45bef \ | perl -pe '$_ .= " -- NO NEWLINE\n" unless /\n/' 4da45be -7134973</tt></pre> +7134973</code></pre> </div></div> -<div class="paragraph"><p>In addition, any unrecognized string that has a <tt>%</tt> in it is interpreted -as if it has <tt>tformat:</tt> in front of it. For example, these two are +<div class="paragraph"><p>In addition, any unrecognized string that has a <code>%</code> in it is interpreted +as if it has <code>tformat:</code> in front of it. For example, these two are equivalent:</p></div> <div class="listingblock"> <div class="content"> -<pre><tt>$ git log -2 --pretty=tformat:%h 4da45bef -$ git log -2 --pretty=%h 4da45bef</tt></pre> +<pre><code>$ git log -2 --pretty=tformat:%h 4da45bef +$ git log -2 --pretty=%h 4da45bef</code></pre> </div></div> </li> </ul></div> </div> +</div> +<div class="sect1"> <h2 id="_limiting_output">Limiting Output</h2> <div class="sectionbody"> <div class="paragraph"><p>If you’re only interested in differences in a subset of files, for example some architecture-specific files, you might do:</p></div> <div class="literalblock"> <div class="content"> -<pre><tt>git diff-tree -r <tree-ish> <tree-ish> arch/ia64 include/asm-ia64</tt></pre> +<pre><code>git diff-tree -r <tree-ish> <tree-ish> arch/ia64 include/asm-ia64</code></pre> </div></div> <div class="paragraph"><p>and it will only show you what changed in those two directories.</p></div> -<div class="paragraph"><p>Or if you are searching for what changed in just <tt>kernel/sched.c</tt>, just do</p></div> +<div class="paragraph"><p>Or if you are searching for what changed in just <code>kernel/sched.c</code>, just do</p></div> <div class="literalblock"> <div class="content"> -<pre><tt>git diff-tree -r <tree-ish> <tree-ish> kernel/sched.c</tt></pre> +<pre><code>git diff-tree -r <tree-ish> <tree-ish> kernel/sched.c</code></pre> </div></div> <div class="paragraph"><p>and it will ignore all differences to other files.</p></div> <div class="paragraph"><p>The pattern is always the prefix, and is matched exactly. There are no wildcards. Even stricter, it has to match a complete path component. -I.e. "foo" does not pick up <tt>foobar.h</tt>. "foo" does match <tt>foo/bar.h</tt> +I.e. "foo" does not pick up <code>foobar.h</code>. "foo" does match <code>foo/bar.h</code> so it can be used to name subdirectories.</p></div> <div class="paragraph"><p>An example of normal usage is:</p></div> <div class="literalblock"> <div class="content"> -<pre><tt>torvalds@ppc970:~/git> git diff-tree --abbrev 5319e4 -:100664 100664 ac348b... a01513... git-fsck-objects.c</tt></pre> +<pre><code>torvalds@ppc970:~/git> git diff-tree --abbrev 5319e4 +:100664 100664 ac348b... a01513... git-fsck-objects.c</code></pre> </div></div> <div class="paragraph"><p>which tells you that the last commit changed just one file (it’s from this one:</p></div> <div class="listingblock"> <div class="content"> -<pre><tt>commit 3c6f7ca19ad4043e9e72fa94106f352897e651a8 +<pre><code>commit 3c6f7ca19ad4043e9e72fa94106f352897e651a8 tree 5319e4d609cdd282069cc4dce33c1db559539b03 parent b4e628ea30d5ab3606119d2ea5caeab141d38df7 author Linus Torvalds <torvalds@ppc970.osdl.org> Sat Apr 9 12:02:30 2005 @@ -2125,10 +2306,12 @@ Make "git-fsck-objects" print out all the root commits it finds. Once I do the reference tracking, I'll also make it print out all the -HEAD commits it finds, which is even more interesting.</tt></pre> +HEAD commits it finds, which is even more interesting.</code></pre> </div></div> <div class="paragraph"><p>in case you care).</p></div> </div> +</div> +<div class="sect1"> <h2 id="_raw_output_format">Raw output format</h2> <div class="sectionbody"> <div class="paragraph"><p>The raw output format from "git-diff-index", "git-diff-tree", @@ -2175,12 +2358,12 @@ <div class="paragraph"><p>An output line is formatted this way:</p></div> <div class="listingblock"> <div class="content"> -<pre><tt>in-place edit :100644 100644 bcd1234... 0123456... M file0 +<pre><code>in-place edit :100644 100644 bcd1234... 0123456... M file0 copy-edit :100644 100644 abcd123... 1234567... C68 file1 file2 rename-edit :100644 100644 abcd123... 1234567... R86 file1 file3 create :000000 100644 0000000... 1234567... A file4 delete :100644 000000 1234567... 0000000... D file5 -unmerged :000000 000000 0000000... 0000000... U file6</tt></pre> +unmerged :000000 000000 0000000... 0000000... U file6</code></pre> </div></div> <div class="paragraph"><p>That is, from the left to the right:</p></div> <div class="olist arabic"><ol class="arabic"> @@ -2312,12 +2495,14 @@ <div class="paragraph"><p>Example:</p></div> <div class="listingblock"> <div class="content"> -<pre><tt>:100644 100644 5be4a4...... 000000...... M file.c</tt></pre> +<pre><code>:100644 100644 5be4a4...... 000000...... M file.c</code></pre> </div></div> -<div class="paragraph"><p>When <tt>-z</tt> option is not used, TAB, LF, and backslash characters -in pathnames are represented as <tt>\t</tt>, <tt>\n</tt>, and <tt>\\</tt>, +<div class="paragraph"><p>When <code>-z</code> option is not used, TAB, LF, and backslash characters +in pathnames are represented as <code>\t</code>, <code>\n</code>, and <code>\\</code>, respectively.</p></div> </div> +</div> +<div class="sect1"> <h2 id="_diff_format_for_merges">diff format for merges</h2> <div class="sectionbody"> <div class="paragraph"><p>"git-diff-tree", "git-diff-files" and "git-diff --raw" @@ -2354,11 +2539,13 @@ <div class="paragraph"><p>Example:</p></div> <div class="listingblock"> <div class="content"> -<pre><tt>::100644 100644 100644 fabadb8... cc95eb0... 4866510... MM describe.c</tt></pre> +<pre><code>::100644 100644 100644 fabadb8... cc95eb0... 4866510... MM describe.c</code></pre> </div></div> <div class="paragraph"><p>Note that <em>combined diff</em> lists only files which were modified from all parents.</p></div> </div> +</div> +<div class="sect1"> <h2 id="_generating_patches_with_p">Generating patches with -p</h2> <div class="sectionbody"> <div class="paragraph"><p>When "git-diff-index", "git-diff-tree", or "git-diff-files" are run @@ -2376,12 +2563,12 @@ </p> <div class="literalblock"> <div class="content"> -<pre><tt>diff --git a/file1 b/file2</tt></pre> +<pre><code>diff --git a/file1 b/file2</code></pre> </div></div> -<div class="paragraph"><p>The <tt>a/</tt> and <tt>b/</tt> filenames are the same unless rename/copy is +<div class="paragraph"><p>The <code>a/</code> and <code>b/</code> filenames are the same unless rename/copy is involved. Especially, even for a creation or a deletion, -<tt>/dev/null</tt> is <em>not</em> used in place of the <tt>a/</tt> or <tt>b/</tt> filenames.</p></div> -<div class="paragraph"><p>When rename/copy is involved, <tt>file1</tt> and <tt>file2</tt> show the +<code>/dev/null</code> is <em>not</em> used in place of the <code>a/</code> or <code>b/</code> filenames.</p></div> +<div class="paragraph"><p>When rename/copy is involved, <code>file1</code> and <code>file2</code> show the name of the source file of the rename/copy and the name of the file that rename/copy produces, respectively.</p></div> </li> @@ -2391,7 +2578,7 @@ </p> <div class="literalblock"> <div class="content"> -<pre><tt>old mode <mode> +<pre><code>old mode <mode> new mode <mode> deleted file mode <mode> new file mode <mode> @@ -2401,11 +2588,11 @@ rename to <path> similarity index <number> dissimilarity index <number> -index <hash>..<hash> <mode></tt></pre> +index <hash>..<hash> <mode></code></pre> </div></div> <div class="paragraph"><p>File modes are printed as 6-digit octal numbers including the file type and file permission bits.</p></div> -<div class="paragraph"><p>Path names in extended headers do not include the <tt>a/</tt> and <tt>b/</tt> prefixes.</p></div> +<div class="paragraph"><p>Path names in extended headers do not include the <code>a/</code> and <code>b/</code> prefixes.</p></div> <div class="paragraph"><p>The similarity index is the percentage of unchanged lines, and the dissimilarity index is the percentage of changed lines. It is a rounded down integer, followed by a percent sign. The @@ -2419,33 +2606,35 @@ <li> <p> TAB, LF, double quote and backslash characters in pathnames - are represented as <tt>\t</tt>, <tt>\n</tt>, <tt>\"</tt> and <tt>\\</tt>, respectively. + are represented as <code>\t</code>, <code>\n</code>, <code>\"</code> and <code>\\</code>, respectively. If there is need for such substitution then the whole pathname is put in double quotes. </p> </li> <li> <p> -All the <tt>file1</tt> files in the output refer to files before the - commit, and all the <tt>file2</tt> files refer to files after the commit. +All the <code>file1</code> files in the output refer to files before the + commit, and all the <code>file2</code> files refer to files after the commit. It is incorrect to apply each change to each file sequentially. For example, this patch will swap a and b: </p> <div class="literalblock"> <div class="content"> -<pre><tt>diff --git a/a b/b +<pre><code>diff --git a/a b/b rename from a rename to b diff --git a/b b/a rename from b -rename to a</tt></pre> +rename to a</code></pre> </div></div> </li> </ol></div> </div> +</div> +<div class="sect1"> <h2 id="_combined_diff_format">combined diff format</h2> <div class="sectionbody"> -<div class="paragraph"><p>Any diff-generating command can take the ‘-c` or <tt>--cc</tt> option to +<div class="paragraph"><p>Any diff-generating command can take the ‘-c` or <code>--cc</code> option to produce a <em>combined diff</em> when showing a merge. This is the default format when showing merges with <a href="git-diff.html">git-diff(1)</a> or <a href="git-show.html">git-show(1)</a>. Note also that you can give the `-m’ option to any @@ -2454,7 +2643,7 @@ <div class="paragraph"><p>A <em>combined diff</em> format looks like this:</p></div> <div class="listingblock"> <div class="content"> -<pre><tt>diff --combined describe.c +<pre><code>diff --combined describe.c index fabadb8,cc95eb0..4866510 --- a/describe.c +++ b/describe.c @@ -2480,7 +2669,7 @@ + if (!initialized) { initialized = 1; - for_each_ref(get_name);</tt></pre> + for_each_ref(get_name);</code></pre> </div></div> <div class="olist arabic"><ol class="arabic"> <li> @@ -2490,12 +2679,12 @@ </p> <div class="literalblock"> <div class="content"> -<pre><tt>diff --combined file</tt></pre> +<pre><code>diff --combined file</code></pre> </div></div> <div class="paragraph"><p>or like this (when <em>--cc</em> option is used):</p></div> <div class="literalblock"> <div class="content"> -<pre><tt>diff --cc file</tt></pre> +<pre><code>diff --cc file</code></pre> </div></div> </li> <li> @@ -2505,12 +2694,12 @@ </p> <div class="literalblock"> <div class="content"> -<pre><tt>index <hash>,<hash>..<hash> +<pre><code>index <hash>,<hash>..<hash> mode <mode>,<mode>..<mode> new file mode <mode> -deleted file mode <mode>,<mode></tt></pre> +deleted file mode <mode>,<mode></code></pre> </div></div> -<div class="paragraph"><p>The <tt>mode <mode>,<mode>..<mode></tt> line appears only if at least one of +<div class="paragraph"><p>The <code>mode <mode>,<mode>..<mode></code> line appears only if at least one of the <mode> is different from the rest. Extended headers with information about detected contents movement (renames and copying detection) are designed to work with diff of two @@ -2522,74 +2711,76 @@ </p> <div class="literalblock"> <div class="content"> -<pre><tt>--- a/file -+++ b/file</tt></pre> +<pre><code>--- a/file ++++ b/file</code></pre> </div></div> <div class="paragraph"><p>Similar to two-line header for traditional <em>unified</em> diff -format, <tt>/dev/null</tt> is used to signal created or deleted +format, <code>/dev/null</code> is used to signal created or deleted files.</p></div> </li> <li> <p> Chunk header format is modified to prevent people from - accidentally feeding it to <tt>patch -p1</tt>. Combined diff format + accidentally feeding it to <code>patch -p1</code>. Combined diff format was created for review of merge commit changes, and was not meant for apply. The change is similar to the change in the extended <em>index</em> header: </p> <div class="literalblock"> <div class="content"> -<pre><tt>@@@ <from-file-range> <from-file-range> <to-file-range> @@@</tt></pre> +<pre><code>@@@ <from-file-range> <from-file-range> <to-file-range> @@@</code></pre> </div></div> -<div class="paragraph"><p>There are (number of parents + 1) <tt>@</tt> characters in the chunk +<div class="paragraph"><p>There are (number of parents + 1) <code>@</code> characters in the chunk header for combined diff format.</p></div> </li> </ol></div> <div class="paragraph"><p>Unlike the traditional <em>unified</em> diff format, which shows two -files A and B with a single column that has <tt>-</tt> (minus — appears in A but removed in B), <tt>+</tt> (plus — missing in A but -added to B), or <tt>" "</tt> (space — unchanged) prefix, this format +files A and B with a single column that has <code>-</code> (minus — appears in A but removed in B), <code>+</code> (plus — missing in A but +added to B), or <code>" "</code> (space — unchanged) prefix, this format compares two or more files file1, file2,… with one file X, and shows how X differs from each of fileN. One column for each of fileN is prepended to the output line to note how X’s line is different from it.</p></div> -<div class="paragraph"><p>A <tt>-</tt> character in the column N means that the line appears in -fileN but it does not appear in the result. A <tt>+</tt> character +<div class="paragraph"><p>A <code>-</code> character in the column N means that the line appears in +fileN but it does not appear in the result. A <code>+</code> character in the column N means that the line appears in the result, and fileN does not have that line (in other words, the line was added, from the point of view of that parent).</p></div> <div class="paragraph"><p>In the above example output, the function signature was changed -from both files (hence two <tt>-</tt> removals from both file1 and -file2, plus <tt>++</tt> to mean one line that was added does not appear +from both files (hence two <code>-</code> removals from both file1 and +file2, plus <code>++</code> to mean one line that was added does not appear in either file1 nor file2). Also eight other lines are the same -from file1 but do not appear in file2 (hence prefixed with <tt>+</tt>).</p></div> -<div class="paragraph"><p>When shown by <tt>git diff-tree -c</tt>, it compares the parents of a +from file1 but do not appear in file2 (hence prefixed with <code>+</code>).</p></div> +<div class="paragraph"><p>When shown by <code>git diff-tree -c</code>, it compares the parents of a merge commit with the merge result (i.e. file1..fileN are the -parents). When shown by <tt>git diff-files -c</tt>, it compares the +parents). When shown by <code>git diff-files -c</code>, it compares the two unresolved merge parents with the working tree file (i.e. file1 is stage 2 aka "our version", file2 is stage 3 aka "their version").</p></div> </div> +</div> +<div class="sect1"> <h2 id="_other_diff_formats">other diff formats</h2> <div class="sectionbody"> -<div class="paragraph"><p>The <tt>--summary</tt> option describes newly added, deleted, renamed and -copied files. The <tt>--stat</tt> option adds diffstat(1) graph to the +<div class="paragraph"><p>The <code>--summary</code> option describes newly added, deleted, renamed and +copied files. The <code>--stat</code> option adds diffstat(1) graph to the output. These options can be combined with other options, such as -<tt>-p</tt>, and are meant for human consumption.</p></div> -<div class="paragraph"><p>When showing a change that involves a rename or a copy, <tt>--stat</tt> output +<code>-p</code>, and are meant for human consumption.</p></div> +<div class="paragraph"><p>When showing a change that involves a rename or a copy, <code>--stat</code> output formats the pathnames compactly by combining common prefix and suffix of -the pathnames. For example, a change that moves <tt>arch/i386/Makefile</tt> to -<tt>arch/x86/Makefile</tt> while modifying 4 lines will be shown like this:</p></div> +the pathnames. For example, a change that moves <code>arch/i386/Makefile</code> to +<code>arch/x86/Makefile</code> while modifying 4 lines will be shown like this:</p></div> <div class="listingblock"> <div class="content"> -<pre><tt>arch/{i386 => x86}/Makefile | 4 +--</tt></pre> +<pre><code>arch/{i386 => x86}/Makefile | 4 +--</code></pre> </div></div> -<div class="paragraph"><p>The <tt>--numstat</tt> option gives the diffstat(1) information but is designed -for easier machine consumption. An entry in <tt>--numstat</tt> output looks +<div class="paragraph"><p>The <code>--numstat</code> option gives the diffstat(1) information but is designed +for easier machine consumption. An entry in <code>--numstat</code> output looks like this:</p></div> <div class="listingblock"> <div class="content"> -<pre><tt>1 2 README -3 1 arch/{i386 => x86}/Makefile</tt></pre> +<pre><code>1 2 README +3 1 arch/{i386 => x86}/Makefile</code></pre> </div></div> <div class="paragraph"><p>That is, from left to right:</p></div> <div class="olist arabic"><ol class="arabic"> @@ -2624,11 +2815,11 @@ </p> </li> </ol></div> -<div class="paragraph"><p>When <tt>-z</tt> output option is in effect, the output is formatted this way:</p></div> +<div class="paragraph"><p>When <code>-z</code> output option is in effect, the output is formatted this way:</p></div> <div class="listingblock"> <div class="content"> -<pre><tt>1 2 README NUL -3 1 NUL arch/i386/Makefile NUL arch/x86/Makefile NUL</tt></pre> +<pre><code>1 2 README NUL +3 1 NUL arch/i386/Makefile NUL arch/x86/Makefile NUL</code></pre> </div></div> <div class="paragraph"><p>That is:</p></div> <div class="olist arabic"><ol class="arabic"> @@ -2678,21 +2869,24 @@ </p> </li> </ol></div> -<div class="paragraph"><p>The extra <tt>NUL</tt> before the preimage path in renamed case is to allow +<div class="paragraph"><p>The extra <code>NUL</code> before the preimage path in renamed case is to allow scripts that read the output to tell if the current record being read is a single-path record or a rename/copy record without reading ahead. -After reading added and deleted lines, reading up to <tt>NUL</tt> would yield -the pathname, but if that is <tt>NUL</tt>, the record will show two paths.</p></div> +After reading added and deleted lines, reading up to <code>NUL</code> would yield +the pathname, but if that is <code>NUL</code>, the record will show two paths.</p></div> </div> +</div> +<div class="sect1"> <h2 id="_git">GIT</h2> <div class="sectionbody"> <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div> </div> </div> +</div> <div id="footnotes"><hr /></div> <div id="footer"> <div id="footer-text"> -Last updated 2011-11-15 13:45:02 PDT +Last updated 2011-11-15 13:45:02 PST </div> </div> </body> diff --git a/git-diff.html b/git-diff.html index ad06a95..85a0f1a 100644 --- a/git-diff.html +++ b/git-diff.html
@@ -2,15 +2,25 @@ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> <head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> -<meta name="generator" content="AsciiDoc 8.5.2" /> +<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" /> +<meta name="generator" content="AsciiDoc 8.6.8" /> <title>git-diff(1)</title> <style type="text/css"> -/* Debug borders */ -p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 { -/* - border: 1px solid red; -*/ +/* Shared CSS for AsciiDoc xhtml11 and html5 backends */ + +/* Default font. */ +body { + font-family: Georgia,serif; +} + +/* Title font. */ +h1, h2, h3, h4, h5, h6, +div.title, caption.title, +thead, p.table.header, +#toctitle, +#author, #revnumber, #revdate, #revremark, +#footer { + font-family: Arial,Helvetica,sans-serif; } body { @@ -35,13 +45,8 @@ color: #083194; } -tt { - color: navy; -} - h1, h2, h3, h4, h5, h6 { color: #527bbd; - font-family: sans-serif; margin-top: 1.2em; margin-bottom: 0.5em; line-height: 1.3; @@ -59,9 +64,11 @@ h3 + * { clear: left; } +h5 { + font-size: 1.0em; +} div.sectionbody { - font-family: serif; margin-left: 0; } @@ -77,45 +84,48 @@ ul, ol, li > p { margin-top: 0; } +ul > li { color: #aaa; } +ul > li > * { color: black; } -pre { +.monospaced, code, pre { + font-family: "Courier New", Courier, monospace; + font-size: inherit; + color: navy; padding: 0; margin: 0; } -span#author { + +#author { color: #527bbd; - font-family: sans-serif; font-weight: bold; font-size: 1.1em; } -span#email { +#email { } -span#revnumber, span#revdate, span#revremark { - font-family: sans-serif; +#revnumber, #revdate, #revremark { } -div#footer { - font-family: sans-serif; +#footer { font-size: small; border-top: 2px solid silver; padding-top: 0.5em; margin-top: 4.0em; } -div#footer-text { +#footer-text { float: left; padding-bottom: 0.5em; } -div#footer-badges { +#footer-badges { float: right; padding-bottom: 0.5em; } -div#preamble { +#preamble { margin-top: 1.5em; margin-bottom: 1.5em; } -div.tableblock, div.imageblock, div.exampleblock, div.verseblock, +div.imageblock, div.exampleblock, div.verseblock, div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock, div.admonitionblock { margin-top: 1.0em; @@ -135,7 +145,6 @@ /* Block element titles. */ div.title, caption.title { color: #527bbd; - font-family: sans-serif; font-weight: bold; text-align: left; margin-top: 1.0em; @@ -157,13 +166,15 @@ div.sidebarblock > div.content { background: #ffffee; - border: 1px solid silver; + border: 1px solid #dddddd; + border-left: 4px solid #f0f0f0; padding: 0.5em; } div.listingblock > div.content { - border: 1px solid silver; - background: #f4f4f4; + border: 1px solid #dddddd; + border-left: 5px solid #f0f0f0; + background: #f8f8f8; padding: 0.5em; } @@ -171,8 +182,8 @@ padding-left: 1.0em; margin-left: 1.0em; margin-right: 10%; - border-left: 5px solid #dddddd; - color: #777777; + border-left: 5px solid #f0f0f0; + color: #888; } div.quoteblock > div.attribution { @@ -180,8 +191,9 @@ text-align: right; } -div.verseblock > div.content { - white-space: pre; +div.verseblock > pre.content { + font-family: inherit; + font-size: inherit; } div.verseblock > div.attribution { padding-top: 0.75em; @@ -254,35 +266,12 @@ margin-bottom: 0.1em; } -div.tableblock > table { - border: 3px solid #527bbd; -} -thead, p.table.header { - font-family: sans-serif; - font-weight: bold; -} tfoot { font-weight: bold; } td > div.verse { white-space: pre; } -p.table { - margin-top: 0; -} -/* Because the table frame attribute is overriden by CSS in most browsers. */ -div.tableblock > table[frame="void"] { - border-style: none; -} -div.tableblock > table[frame="hsides"] { - border-left-style: none; - border-right-style: none; -} -div.tableblock > table[frame="vsides"] { - border-top-style: none; - border-bottom-style: none; -} - div.hdlist { margin-top: 0.8em; @@ -339,25 +328,32 @@ min-width: 100px; } - -@media print { - div#footer-badges { display: none; } +div.colist td { + padding-right: 0.5em; + padding-bottom: 0.3em; + vertical-align: top; +} +div.colist td img { + margin-top: 0.3em; } -div#toc { +@media print { + #footer-badges { display: none; } +} + +#toc { margin-bottom: 2.5em; } -div#toctitle { +#toctitle { color: #527bbd; - font-family: sans-serif; font-size: 1.1em; font-weight: bold; margin-top: 1.0em; margin-bottom: 0.1em; } -div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 { +div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 { margin-top: 0; margin-bottom: 0; } @@ -373,69 +369,173 @@ margin-left: 6em; font-size: 0.9em; } -/* Overrides for manpage documents */ -h1 { + +span.aqua { color: aqua; } +span.black { color: black; } +span.blue { color: blue; } +span.fuchsia { color: fuchsia; } +span.gray { color: gray; } +span.green { color: green; } +span.lime { color: lime; } +span.maroon { color: maroon; } +span.navy { color: navy; } +span.olive { color: olive; } +span.purple { color: purple; } +span.red { color: red; } +span.silver { color: silver; } +span.teal { color: teal; } +span.white { color: white; } +span.yellow { color: yellow; } + +span.aqua-background { background: aqua; } +span.black-background { background: black; } +span.blue-background { background: blue; } +span.fuchsia-background { background: fuchsia; } +span.gray-background { background: gray; } +span.green-background { background: green; } +span.lime-background { background: lime; } +span.maroon-background { background: maroon; } +span.navy-background { background: navy; } +span.olive-background { background: olive; } +span.purple-background { background: purple; } +span.red-background { background: red; } +span.silver-background { background: silver; } +span.teal-background { background: teal; } +span.white-background { background: white; } +span.yellow-background { background: yellow; } + +span.big { font-size: 2em; } +span.small { font-size: 0.6em; } + +span.underline { text-decoration: underline; } +span.overline { text-decoration: overline; } +span.line-through { text-decoration: line-through; } + +div.unbreakable { page-break-inside: avoid; } + + +/* + * xhtml11 specific + * + * */ + +div.tableblock { + margin-top: 1.0em; + margin-bottom: 1.5em; +} +div.tableblock > table { + border: 3px solid #527bbd; +} +thead, p.table.header { + font-weight: bold; + color: #527bbd; +} +p.table { + margin-top: 0; +} +/* Because the table frame attribute is overriden by CSS in most browsers. */ +div.tableblock > table[frame="void"] { + border-style: none; +} +div.tableblock > table[frame="hsides"] { + border-left-style: none; + border-right-style: none; +} +div.tableblock > table[frame="vsides"] { + border-top-style: none; + border-bottom-style: none; +} + + +/* + * html5 specific + * + * */ + +table.tableblock { + margin-top: 1.0em; + margin-bottom: 1.5em; +} +thead, p.tableblock.header { + font-weight: bold; + color: #527bbd; +} +p.tableblock { + margin-top: 0; +} +table.tableblock { + border-width: 3px; + border-spacing: 0px; + border-style: solid; + border-color: #527bbd; + border-collapse: collapse; +} +th.tableblock, td.tableblock { + border-width: 1px; + padding: 4px; + border-style: solid; + border-color: #527bbd; +} + +table.tableblock.frame-topbot { + border-left-style: hidden; + border-right-style: hidden; +} +table.tableblock.frame-sides { + border-top-style: hidden; + border-bottom-style: hidden; +} +table.tableblock.frame-none { + border-style: hidden; +} + +th.tableblock.halign-left, td.tableblock.halign-left { + text-align: left; +} +th.tableblock.halign-center, td.tableblock.halign-center { + text-align: center; +} +th.tableblock.halign-right, td.tableblock.halign-right { + text-align: right; +} + +th.tableblock.valign-top, td.tableblock.valign-top { + vertical-align: top; +} +th.tableblock.valign-middle, td.tableblock.valign-middle { + vertical-align: middle; +} +th.tableblock.valign-bottom, td.tableblock.valign-bottom { + vertical-align: bottom; +} + + +/* + * manpage specific + * + * */ + +body.manpage h1 { padding-top: 0.5em; padding-bottom: 0.5em; border-top: 2px solid silver; border-bottom: 2px solid silver; } -h2 { +body.manpage h2 { border-style: none; } -div.sectionbody { - margin-left: 5%; +body.manpage div.sectionbody { + margin-left: 3em; } @media print { - div#toc { display: none; } + body.manpage div#toc { display: none; } } -/* Workarounds for IE6's broken and incomplete CSS2. */ -div.sidebar-content { - background: #ffffee; - border: 1px solid silver; - padding: 0.5em; -} -div.sidebar-title, div.image-title { - color: #527bbd; - font-family: sans-serif; - font-weight: bold; - margin-top: 0.0em; - margin-bottom: 0.5em; -} - -div.listingblock div.content { - border: 1px solid silver; - background: #f4f4f4; - padding: 0.5em; -} - -div.quoteblock-attribution { - padding-top: 0.5em; - text-align: right; -} - -div.verseblock-content { - white-space: pre; -} -div.verseblock-attribution { - padding-top: 0.75em; - text-align: left; -} - -div.exampleblock-content { - border-left: 3px solid #dddddd; - padding-left: 0.5em; -} - -/* IE6 sets dynamically generated links as visited. */ -div#toc a:visited { color: blue; } </style> <script type="text/javascript"> /*<+'])'); + var re = new RegExp('[hH]([1-'+(toclevels+1)+'])'); // Function that scans the DOM tree for header elements (the DOM2 // nodeIterator API would be a better technique but not supported by all // browsers). @@ -497,6 +597,25 @@ } var toc = document.getElementById("toc"); + if (!toc) { + return; + } + + // Delete existing TOC entries in case we're reloading the TOC. + var tocEntriesToRemove = []; + var i; + for (i = 0; i < toc.childNodes.length; i++) { + var entry = toc.childNodes[i]; + if (entry.nodeName.toLowerCase() == 'div' + && entry.getAttribute("class") + && entry.getAttribute("class").match(/^toclevel/)) + tocEntriesToRemove.push(entry); + } + for (i = 0; i < tocEntriesToRemove.length; i++) { + toc.removeChild(tocEntriesToRemove[i]); + } + + // Rebuild TOC entries. var entries = tocEntries(document.getElementById("content"), toclevels); for (var i = 0; i < entries.length; ++i) { var entry = entries[i]; @@ -524,24 +643,44 @@ */ footnotes: function () { - var cont = document.getElementById("content"); + // Delete existing footnote entries in case we're reloading the footnodes. + var i; var noteholder = document.getElementById("footnotes"); + if (!noteholder) { + return; + } + var entriesToRemove = []; + for (i = 0; i < noteholder.childNodes.length; i++) { + var entry = noteholder.childNodes[i]; + if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote") + entriesToRemove.push(entry); + } + for (i = 0; i < entriesToRemove.length; i++) { + noteholder.removeChild(entriesToRemove[i]); + } + + // Rebuild footnote entries. + var cont = document.getElementById("content"); var spans = cont.getElementsByTagName("span"); var refs = {}; var n = 0; for (i=0; i<spans.length; i++) { if (spans[i].className == "footnote") { n++; - // Use [\s\S] in place of . so multi-line matches work. - // Because JavaScript has no s (dotall) regex flag. - note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1]; + var note = spans[i].getAttribute("data-note"); + if (!note) { + // Use [\s\S] in place of . so multi-line matches work. + // Because JavaScript has no s (dotall) regex flag. + note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1]; + spans[i].innerHTML = + "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n + + "' title='View footnote' class='footnote'>" + n + "</a>]"; + spans[i].setAttribute("data-note", note); + } noteholder.innerHTML += "<div class='footnote' id='_footnote_" + n + "'>" + "<a href='#_footnoteref_" + n + "' title='Return to text'>" + n + "</a>. " + note + "</div>"; - spans[i].innerHTML = - "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n + - "' title='View footnote' class='footnote'>" + n + "</a>]"; var id =spans[i].getAttribute("id"); if (id != null) refs["#"+id] = n; } @@ -561,13 +700,36 @@ } } } +}, + +install: function(toclevels) { + var timerId; + + function reinstall() { + asciidoc.footnotes(); + if (toclevels) { + asciidoc.toc(toclevels); + } + } + + function reinstallAndRemoveTimer() { + clearInterval(timerId); + reinstall(); + } + + timerId = setInterval(reinstall, 500); + if (document.addEventListener) + document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false); + else + window.onload = reinstallAndRemoveTimer; } } +asciidoc.install(); /*]]>*/ </script> </head> -<body> +<body class="manpage"> <div id="header"> <h1> git-diff(1) Manual Page @@ -580,16 +742,19 @@ </div> </div> <div id="content"> +<div class="sect1"> <h2 id="_synopsis">SYNOPSIS</h2> <div class="sectionbody"> <div class="verseblock"> -<div class="verseblock-content"><em>git diff</em> [options] [<commit>] [--] [<path>…] +<pre class="content"><em>git diff</em> [options] [<commit>] [--] [<path>…] <em>git diff</em> [options] --cached [<commit>] [--] [<path>…] <em>git diff</em> [options] <commit> <commit> [--] [<path>…] -<em>git diff</em> [options] [--no-index] [--] <path> <path></div> -<div class="verseblock-attribution"> +<em>git diff</em> [options] [--no-index] [--] <path> <path></pre> +<div class="attribution"> </div></div> </div> +</div> +<div class="sect1"> <h2 id="_description">DESCRIPTION</h2> <div class="sectionbody"> <div class="paragraph"><p>Show changes between the working tree and the index or a tree, changes @@ -681,6 +846,8 @@ "<commit>...<commit>") do not mean a range as defined in the "SPECIFYING RANGES" section in <a href="gitrevisions.html">gitrevisions(7)</a>.</p></div> </div> +</div> +<div class="sect1"> <h2 id="_options">OPTIONS</h2> <div class="sectionbody"> <div class="dlist"><dl> @@ -709,7 +876,7 @@ <p> Generate diffs with <n> lines of context instead of the usual three. - Implies <tt>-p</tt>. + Implies <code>-p</code>. </p> </dd> <dt class="hdlist1"> @@ -726,7 +893,7 @@ </dt> <dd> <p> - Synonym for <tt>-p --raw</tt>. + Synonym for <code>-p --raw</code>. </p> </dd> <dt class="hdlist1"> @@ -763,29 +930,29 @@ will be used for the filename part, and the rest for the graph part. Maximum width defaults to terminal width, or 80 columns if not connected to a terminal, and can be overridden by - <tt><width></tt>. The width of the filename part can be limited by - giving another width <tt><name-width></tt> after a comma. The width + <code><width></code>. The width of the filename part can be limited by + giving another width <code><name-width></code> after a comma. The width of the graph part can be limited by using - <tt>--stat-graph-width=<width></tt> (affects all commands generating - a stat graph) or by setting <tt>diff.statGraphWidth=<width></tt> - (does not affect <tt>git format-patch</tt>). - By giving a third parameter <tt><count></tt>, you can limit the - output to the first <tt><count></tt> lines, followed by <tt>...</tt> if + <code>--stat-graph-width=<width></code> (affects all commands generating + a stat graph) or by setting <code>diff.statGraphWidth=<width></code> + (does not affect <code>git format-patch</code>). + By giving a third parameter <code><count></code>, you can limit the + output to the first <code><count></code> lines, followed by <code>...</code> if there are more. </p> -<div class="paragraph"><p>These parameters can also be set individually with <tt>--stat-width=<width></tt>, -<tt>--stat-name-width=<name-width></tt> and <tt>--stat-count=<count></tt>.</p></div> +<div class="paragraph"><p>These parameters can also be set individually with <code>--stat-width=<width></code>, +<code>--stat-name-width=<name-width></code> and <code>--stat-count=<count></code>.</p></div> </dd> <dt class="hdlist1"> --numstat </dt> <dd> <p> - Similar to <tt>--stat</tt>, but shows number of added and + Similar to <code>--stat</code>, but shows number of added and deleted lines in decimal notation and pathname without abbreviation, to make it more machine friendly. For - binary files, outputs two <tt>-</tt> instead of saying - <tt>0 0</tt>. + binary files, outputs two <code>-</code> instead of saying + <code>0 0</code>. </p> </dd> <dt class="hdlist1"> @@ -793,7 +960,7 @@ </dt> <dd> <p> - Output only the last line of the <tt>--stat</tt> format containing total + Output only the last line of the <code>--stat</code> format containing total number of modified files, as well as number of added and deleted lines. </p> @@ -804,15 +971,17 @@ <dd> <p> Output the distribution of relative amount of changes for each - sub-directory. The behavior of <tt>--dirstat</tt> can be customized by + sub-directory. The behavior of <code>--dirstat</code> can be customized by passing it a comma separated list of parameters. - The defaults are controlled by the <tt>diff.dirstat</tt> configuration + The defaults are controlled by the <code>diff.dirstat</code> configuration variable (see <a href="git-config.html">git-config(1)</a>). The following parameters are available: </p> +<div class="openblock"> +<div class="content"> <div class="dlist"><dl> <dt class="hdlist1"> -<tt>changes</tt> +<code>changes</code> </dt> <dd> <p> @@ -824,39 +993,39 @@ </p> </dd> <dt class="hdlist1"> -<tt>lines</tt> +<code>lines</code> </dt> <dd> <p> Compute the dirstat numbers by doing the regular line-based diff analysis, and summing the removed/added line counts. (For binary files, count 64-byte chunks instead, since binary files have no - natural concept of lines). This is a more expensive <tt>--dirstat</tt> - behavior than the <tt>changes</tt> behavior, but it does count rearranged + natural concept of lines). This is a more expensive <code>--dirstat</code> + behavior than the <code>changes</code> behavior, but it does count rearranged lines within a file as much as other changes. The resulting output - is consistent with what you get from the other <tt>--*stat</tt> options. + is consistent with what you get from the other <code>--*stat</code> options. </p> </dd> <dt class="hdlist1"> -<tt>files</tt> +<code>files</code> </dt> <dd> <p> Compute the dirstat numbers by counting the number of files changed. Each changed file counts equally in the dirstat analysis. This is - the computationally cheapest <tt>--dirstat</tt> behavior, since it does + the computationally cheapest <code>--dirstat</code> behavior, since it does not have to look at the file contents at all. </p> </dd> <dt class="hdlist1"> -<tt>cumulative</tt> +<code>cumulative</code> </dt> <dd> <p> Count changes in a child directory for the parent directory as well. - Note that when using <tt>cumulative</tt>, the sum of the percentages + Note that when using <code>cumulative</code>, the sum of the percentages reported may exceed 100%. The default (non-cumulative) behavior can - be specified with the <tt>noncumulative</tt> parameter. + be specified with the <code>noncumulative</code> parameter. </p> </dd> <dt class="hdlist1"> @@ -870,10 +1039,11 @@ </p> </dd> </dl></div> +</div></div> <div class="paragraph"><p>Example: The following will count changed files, while ignoring directories with less than 10% of the total amount of changed files, and accumulating child directory counts in the parent directories: -<tt>--dirstat=files,10,cumulative</tt>.</p></div> +<code>--dirstat=files,10,cumulative</code>.</p></div> </dd> <dt class="hdlist1"> --summary @@ -889,7 +1059,7 @@ </dt> <dd> <p> - Synonym for <tt>-p --stat</tt>. + Synonym for <code>-p --stat</code>. </p> </dd> <dt class="hdlist1"> @@ -897,11 +1067,11 @@ </dt> <dd> <p> - When <tt>--raw</tt>, <tt>--numstat</tt>, <tt>--name-only</tt> or <tt>--name-status</tt> has been + When <code>--raw</code>, <code>--numstat</code>, <code>--name-only</code> or <code>--name-status</code> has been given, do not munge pathnames and use NULs as output field terminators. </p> <div class="paragraph"><p>Without this option, each pathname output will have TAB, LF, double quotes, -and backslash characters replaced with <tt>\t</tt>, <tt>\n</tt>, <tt>\"</tt>, and <tt>\\</tt>, +and backslash characters replaced with <code>\t</code>, <code>\n</code>, <code>\"</code>, and <code>\\</code>, respectively, and the pathname will be enclosed in double quotes if any of those replacements occurred.</p></div> </dd> @@ -919,7 +1089,7 @@ <dd> <p> Show only names and status of changed files. See the description - of the <tt>--diff-filter</tt> option on what the status letters mean. + of the <code>--diff-filter</code> option on what the status letters mean. </p> </dd> <dt class="hdlist1"> @@ -927,13 +1097,13 @@ </dt> <dd> <p> - Specify how differences in submodules are shown. When <tt>--submodule</tt> - or <tt>--submodule=log</tt> is given, the <em>log</em> format is used. This format lists - the commits in the range like <a href="git-submodule.html">git-submodule(1)</a> <tt>summary</tt> does. - Omitting the <tt>--submodule</tt> option or specifying <tt>--submodule=short</tt>, + Specify how differences in submodules are shown. When <code>--submodule</code> + or <code>--submodule=log</code> is given, the <em>log</em> format is used. This format lists + the commits in the range like <a href="git-submodule.html">git-submodule(1)</a> <code>summary</code> does. + Omitting the <code>--submodule</code> option or specifying <code>--submodule=short</code>, uses the <em>short</em> format. This format just shows the names of the commits at the beginning and end of the range. Can be tweaked via the - <tt>diff.submodule</tt> configuration variable. + <code>diff.submodule</code> configuration variable. </p> </dd> <dt class="hdlist1"> @@ -942,9 +1112,9 @@ <dd> <p> Show colored diff. - The value must be <tt>always</tt> (the default for <tt><when></tt>), <tt>never</tt>, or <tt>auto</tt>. - The default value is <tt>never</tt>. - It can be changed by the <tt>color.ui</tt> and <tt>color.diff</tt> + The value must be <code>always</code> (the default for <code><when></code>), <code>never</code>, or <code>auto</code>. + The default value is <code>never</code>. + It can be changed by the <code>color.ui</code> and <code>color.diff</code> configuration settings. </p> </dd> @@ -955,7 +1125,7 @@ <p> Turn off colored diff. This can be used to override configuration settings. - It is the same as <tt>--color=never</tt>. + It is the same as <code>--color=never</code>. </p> </dd> <dt class="hdlist1"> @@ -965,16 +1135,18 @@ <p> Show a word diff, using the <mode> to delimit changed words. By default, words are delimited by whitespace; see - <tt>--word-diff-regex</tt> below. The <mode> defaults to <em>plain</em>, and + <code>--word-diff-regex</code> below. The <mode> defaults to <em>plain</em>, and must be one of: </p> +<div class="openblock"> +<div class="content"> <div class="dlist"><dl> <dt class="hdlist1"> color </dt> <dd> <p> - Highlight changed words using only colors. Implies <tt>--color</tt>. + Highlight changed words using only colors. Implies <code>--color</code>. </p> </dd> <dt class="hdlist1"> @@ -982,7 +1154,7 @@ </dt> <dd> <p> - Show words as <tt>[-removed-]</tt> and <tt>{+added+}</tt>. Makes no + Show words as <code>[-removed-]</code> and <code>{+added+}</code>. Makes no attempts to escape the delimiters if they appear in the input, so the output may be ambiguous. </p> @@ -994,10 +1166,10 @@ <p> Use a special line-based format intended for script consumption. Added/removed/unchanged runs are printed in the - usual unified diff format, starting with a <tt>+</tt>/<tt>-</tt>/` ` + usual unified diff format, starting with a <code>+</code>/<code>-</code>/` ` character at the beginning of the line and extending to the end of the line. Newlines in the input are represented by a - tilde <tt>~</tt> on a line of its own. + tilde <code>~</code> on a line of its own. </p> </dd> <dt class="hdlist1"> @@ -1009,6 +1181,7 @@ </p> </dd> </dl></div> +</div></div> <div class="paragraph"><p>Note that despite the name of the first mode, color is used to highlight the changed parts in all modes if enabled.</p></div> </dd> @@ -1019,12 +1192,12 @@ <p> Use <regex> to decide what a word is, instead of considering runs of non-whitespace to be a word. Also implies - <tt>--word-diff</tt> unless it was already enabled. + <code>--word-diff</code> unless it was already enabled. </p> <div class="paragraph"><p>Every non-overlapping match of the <regex> is considered a word. Anything between these matches is considered whitespace and ignored(!) for the purposes of finding -differences. You may want to append <tt>|[^[:space:]]</tt> to your regular +differences. You may want to append <code>|[^[:space:]]</code> to your regular expression to make sure that it matches all non-whitespace characters. A match that contains a newline is silently truncated(!) at the newline.</p></div> @@ -1038,8 +1211,8 @@ </dt> <dd> <p> - Equivalent to <tt>--word-diff=color</tt> plus (if a regex was - specified) <tt>--word-diff-regex=<regex></tt>. + Equivalent to <code>--word-diff=color</code> plus (if a regex was + specified) <code>--word-diff-regex=<regex></code>. </p> </dd> <dt class="hdlist1"> @@ -1057,7 +1230,7 @@ <dd> <p> Warn if changes introduce whitespace errors. What are - considered whitespace errors is controlled by <tt>core.whitespace</tt> + considered whitespace errors is controlled by <code>core.whitespace</code> configuration. By default, trailing whitespaces (including lines that solely consist of whitespaces) and a space character that is immediately followed by a tab character inside the @@ -1081,8 +1254,8 @@ </dt> <dd> <p> - In addition to <tt>--full-index</tt>, output a binary diff that - can be applied with <tt>git-apply</tt>. + In addition to <code>--full-index</code>, output a binary diff that + can be applied with <code>git-apply</code>. </p> </dd> <dt class="hdlist1"> @@ -1093,9 +1266,9 @@ Instead of showing the full 40-byte hexadecimal object name in diff-raw format output and diff-tree header lines, show only a partial prefix. This is - independent of the <tt>--full-index</tt> option above, which controls + independent of the <code>--full-index</code> option above, which controls the diff-patch output format. Non default number of - digits can be specified with <tt>--abbrev=<n></tt>. + digits can be specified with <code>--abbrev=<n></code>. </p> </dd> <dt class="hdlist1"> @@ -1113,15 +1286,15 @@ not as a series of deletion and insertion mixed together with a very few lines that happen to match textually as the context, but as a single deletion of everything old followed by a single insertion of -everything new, and the number <tt>m</tt> controls this aspect of the -B -option (defaults to 60%). <tt>-B/70%</tt> specifies that less than 30% of the +everything new, and the number <code>m</code> controls this aspect of the -B +option (defaults to 60%). <code>-B/70%</code> specifies that less than 30% of the original should remain in the result for git to consider it a total rewrite (i.e. otherwise the resulting patch will be a series of deletion and insertion mixed together with context lines).</p></div> <div class="paragraph"><p>When used with -M, a totally-rewritten file is also considered as the source of a rename (usually -M only considers a file that disappeared -as the source of a rename), and the number <tt>n</tt> controls this aspect of -the -B option (defaults to 50%). <tt>-B20%</tt> specifies that a change with +as the source of a rename), and the number <code>n</code> controls this aspect of +the -B option (defaults to 50%). <code>-B20%</code> specifies that a change with addition and deletion compared to 20% or more of the file’s size are eligible for being picked up as a possible source of a rename to another file.</p></div> @@ -1135,11 +1308,15 @@ <dd> <p> Detect renames. - If <tt>n</tt> is specified, it is a threshold on the similarity + If <code>n</code> is specified, it is a threshold on the similarity index (i.e. amount of addition/deletions compared to the - file’s size). For example, <tt>-M90%</tt> means git should consider a + file’s size). For example, <code>-M90%</code> means git should consider a delete/add pair to be a rename if more than 90% of the file - hasn’t changed. + hasn’t changed. Without a <code>%</code> sign, the number is to be read as + a fraction, with a decimal point before it. I.e., <code>-M5</code> becomes + 0.5, and is thus the same as <code>-M50%</code>. Similarly, <code>-M05</code> is + the same as <code>-M5%</code>. To limit detection to exact renames, use + <code>-M100%</code>. </p> </dd> <dt class="hdlist1"> @@ -1150,8 +1327,8 @@ </dt> <dd> <p> - Detect copies as well as renames. See also <tt>--find-copies-harder</tt>. - If <tt>n</tt> is specified, it has the same meaning as for <tt>-M<n></tt>. + Detect copies as well as renames. See also <code>--find-copies-harder</code>. + If <code>n</code> is specified, it has the same meaning as for <code>-M<n></code>. </p> </dd> <dt class="hdlist1"> @@ -1159,13 +1336,13 @@ </dt> <dd> <p> - For performance reasons, by default, <tt>-C</tt> option finds copies only + For performance reasons, by default, <code>-C</code> option finds copies only if the original file of the copy was modified in the same changeset. This flag makes the command inspect unmodified files as candidates for the source of copy. This is a very expensive operation for large projects, so use it with caution. Giving more than one - <tt>-C</tt> option has the same effect. + <code>-C</code> option has the same effect. </p> </dd> <dt class="hdlist1"> @@ -1177,14 +1354,14 @@ <dd> <p> Omit the preimage for deletes, i.e. print only the header but not - the diff between the preimage and <tt>/dev/null</tt>. The resulting patch - is not meant to be applied with <tt>patch</tt> nor <tt>git apply</tt>; this is + the diff between the preimage and <code>/dev/null</code>. The resulting patch + is not meant to be applied with <code>patch</code> nor <code>git apply</code>; this is solely for people who want to just concentrate on reviewing the text after the change. In addition, the output obviously lack enough information to apply such a patch in reverse, even manually, hence the name of the option. </p> -<div class="paragraph"><p>When used together with <tt>-B</tt>, omit also the preimage in the deletion part +<div class="paragraph"><p>When used together with <code>-B</code>, omit also the preimage in the deletion part of a delete/create pair.</p></div> </dd> <dt class="hdlist1"> @@ -1192,7 +1369,7 @@ </dt> <dd> <p> - The <tt>-M</tt> and <tt>-C</tt> options require O(n^2) processing time where n + The <code>-M</code> and <code>-C</code> options require O(n^2) processing time where n is the number of potential rename/copy targets. This option prevents rename/copy detection from running if the number of rename/copy targets exceeds the specified @@ -1204,13 +1381,13 @@ </dt> <dd> <p> - Select only files that are Added (<tt>A</tt>), Copied (<tt>C</tt>), - Deleted (<tt>D</tt>), Modified (<tt>M</tt>), Renamed (<tt>R</tt>), have their - type (i.e. regular file, symlink, submodule, …) changed (<tt>T</tt>), - are Unmerged (<tt>U</tt>), are - Unknown (<tt>X</tt>), or have had their pairing Broken (<tt>B</tt>). + Select only files that are Added (<code>A</code>), Copied (<code>C</code>), + Deleted (<code>D</code>), Modified (<code>M</code>), Renamed (<code>R</code>), have their + type (i.e. regular file, symlink, submodule, …) changed (<code>T</code>), + are Unmerged (<code>U</code>), are + Unknown (<code>X</code>), or have had their pairing Broken (<code>B</code>). Any combination of the filter characters (including none) can be used. - When <tt>*</tt> (All-or-none) is added to the combination, all + When <code>*</code> (All-or-none) is added to the combination, all paths are selected if there is any file that matches other criteria in the comparison; if there is no file that matches other criteria, nothing is selected. @@ -1241,7 +1418,7 @@ </dt> <dd> <p> - When <tt>-S</tt> or <tt>-G</tt> finds a change, show all the changes in that + When <code>-S</code> or <code>-G</code> finds a change, show all the changes in that changeset, not just the files that contain the change in <string>. </p> @@ -1366,7 +1543,7 @@ </dt> <dd> <p> - Disable all output of the program. Implies <tt>--exit-code</tt>. + Disable all output of the program. Implies <code>--exit-code</code>. </p> </dd> <dt class="hdlist1"> @@ -1463,6 +1640,8 @@ </dd> </dl></div> </div> +</div> +<div class="sect1"> <h2 id="_raw_output_format">Raw output format</h2> <div class="sectionbody"> <div class="paragraph"><p>The raw output format from "git-diff-index", "git-diff-tree", @@ -1509,12 +1688,12 @@ <div class="paragraph"><p>An output line is formatted this way:</p></div> <div class="listingblock"> <div class="content"> -<pre><tt>in-place edit :100644 100644 bcd1234... 0123456... M file0 +<pre><code>in-place edit :100644 100644 bcd1234... 0123456... M file0 copy-edit :100644 100644 abcd123... 1234567... C68 file1 file2 rename-edit :100644 100644 abcd123... 1234567... R86 file1 file3 create :000000 100644 0000000... 1234567... A file4 delete :100644 000000 1234567... 0000000... D file5 -unmerged :000000 000000 0000000... 0000000... U file6</tt></pre> +unmerged :000000 000000 0000000... 0000000... U file6</code></pre> </div></div> <div class="paragraph"><p>That is, from the left to the right:</p></div> <div class="olist arabic"><ol class="arabic"> @@ -1646,12 +1825,14 @@ <div class="paragraph"><p>Example:</p></div> <div class="listingblock"> <div class="content"> -<pre><tt>:100644 100644 5be4a4...... 000000...... M file.c</tt></pre> +<pre><code>:100644 100644 5be4a4...... 000000...... M file.c</code></pre> </div></div> -<div class="paragraph"><p>When <tt>-z</tt> option is not used, TAB, LF, and backslash characters -in pathnames are represented as <tt>\t</tt>, <tt>\n</tt>, and <tt>\\</tt>, +<div class="paragraph"><p>When <code>-z</code> option is not used, TAB, LF, and backslash characters +in pathnames are represented as <code>\t</code>, <code>\n</code>, and <code>\\</code>, respectively.</p></div> </div> +</div> +<div class="sect1"> <h2 id="_diff_format_for_merges">diff format for merges</h2> <div class="sectionbody"> <div class="paragraph"><p>"git-diff-tree", "git-diff-files" and "git-diff --raw" @@ -1688,11 +1869,13 @@ <div class="paragraph"><p>Example:</p></div> <div class="listingblock"> <div class="content"> -<pre><tt>::100644 100644 100644 fabadb8... cc95eb0... 4866510... MM describe.c</tt></pre> +<pre><code>::100644 100644 100644 fabadb8... cc95eb0... 4866510... MM describe.c</code></pre> </div></div> <div class="paragraph"><p>Note that <em>combined diff</em> lists only files which were modified from all parents.</p></div> </div> +</div> +<div class="sect1"> <h2 id="_generating_patches_with_p">Generating patches with -p</h2> <div class="sectionbody"> <div class="paragraph"><p>When "git-diff-index", "git-diff-tree", or "git-diff-files" are run @@ -1710,12 +1893,12 @@ </p> <div class="literalblock"> <div class="content"> -<pre><tt>diff --git a/file1 b/file2</tt></pre> +<pre><code>diff --git a/file1 b/file2</code></pre> </div></div> -<div class="paragraph"><p>The <tt>a/</tt> and <tt>b/</tt> filenames are the same unless rename/copy is +<div class="paragraph"><p>The <code>a/</code> and <code>b/</code> filenames are the same unless rename/copy is involved. Especially, even for a creation or a deletion, -<tt>/dev/null</tt> is <em>not</em> used in place of the <tt>a/</tt> or <tt>b/</tt> filenames.</p></div> -<div class="paragraph"><p>When rename/copy is involved, <tt>file1</tt> and <tt>file2</tt> show the +<code>/dev/null</code> is <em>not</em> used in place of the <code>a/</code> or <code>b/</code> filenames.</p></div> +<div class="paragraph"><p>When rename/copy is involved, <code>file1</code> and <code>file2</code> show the name of the source file of the rename/copy and the name of the file that rename/copy produces, respectively.</p></div> </li> @@ -1725,7 +1908,7 @@ </p> <div class="literalblock"> <div class="content"> -<pre><tt>old mode <mode> +<pre><code>old mode <mode> new mode <mode> deleted file mode <mode> new file mode <mode> @@ -1735,11 +1918,11 @@ rename to <path> similarity index <number> dissimilarity index <number> -index <hash>..<hash> <mode></tt></pre> +index <hash>..<hash> <mode></code></pre> </div></div> <div class="paragraph"><p>File modes are printed as 6-digit octal numbers including the file type and file permission bits.</p></div> -<div class="paragraph"><p>Path names in extended headers do not include the <tt>a/</tt> and <tt>b/</tt> prefixes.</p></div> +<div class="paragraph"><p>Path names in extended headers do not include the <code>a/</code> and <code>b/</code> prefixes.</p></div> <div class="paragraph"><p>The similarity index is the percentage of unchanged lines, and the dissimilarity index is the percentage of changed lines. It is a rounded down integer, followed by a percent sign. The @@ -1753,33 +1936,35 @@ <li> <p> TAB, LF, double quote and backslash characters in pathnames - are represented as <tt>\t</tt>, <tt>\n</tt>, <tt>\"</tt> and <tt>\\</tt>, respectively. + are represented as <code>\t</code>, <code>\n</code>, <code>\"</code> and <code>\\</code>, respectively. If there is need for such substitution then the whole pathname is put in double quotes. </p> </li> <li> <p> -All the <tt>file1</tt> files in the output refer to files before the - commit, and all the <tt>file2</tt> files refer to files after the commit. +All the <code>file1</code> files in the output refer to files before the + commit, and all the <code>file2</code> files refer to files after the commit. It is incorrect to apply each change to each file sequentially. For example, this patch will swap a and b: </p> <div class="literalblock"> <div class="content"> -<pre><tt>diff --git a/a b/b +<pre><code>diff --git a/a b/b rename from a rename to b diff --git a/b b/a rename from b -rename to a</tt></pre> +rename to a</code></pre> </div></div> </li> </ol></div> </div> +</div> +<div class="sect1"> <h2 id="_combined_diff_format">combined diff format</h2> <div class="sectionbody"> -<div class="paragraph"><p>Any diff-generating command can take the ‘-c` or <tt>--cc</tt> option to +<div class="paragraph"><p>Any diff-generating command can take the ‘-c` or <code>--cc</code> option to produce a <em>combined diff</em> when showing a merge. This is the default format when showing merges with <a href="git-diff.html">git-diff(1)</a> or <a href="git-show.html">git-show(1)</a>. Note also that you can give the `-m’ option to any @@ -1788,7 +1973,7 @@ <div class="paragraph"><p>A <em>combined diff</em> format looks like this:</p></div> <div class="listingblock"> <div class="content"> -<pre><tt>diff --combined describe.c +<pre><code>diff --combined describe.c index fabadb8,cc95eb0..4866510 --- a/describe.c +++ b/describe.c @@ -1814,7 +1999,7 @@ + if (!initialized) { initialized = 1; - for_each_ref(get_name);</tt></pre> + for_each_ref(get_name);</code></pre> </div></div> <div class="olist arabic"><ol class="arabic"> <li> @@ -1824,12 +2009,12 @@ </p> <div class="literalblock"> <div class="content"> -<pre><tt>diff --combined file</tt></pre> +<pre><code>diff --combined file</code></pre> </div></div> <div class="paragraph"><p>or like this (when <em>--cc</em> option is used):</p></div> <div class="literalblock"> <div class="content"> -<pre><tt>diff --cc file</tt></pre> +<pre><code>diff --cc file</code></pre> </div></div> </li> <li> @@ -1839,12 +2024,12 @@ </p> <div class="literalblock"> <div class="content"> -<pre><tt>index <hash>,<hash>..<hash> +<pre><code>index <hash>,<hash>..<hash> mode <mode>,<mode>..<mode> new file mode <mode> -deleted file mode <mode>,<mode></tt></pre> +deleted file mode <mode>,<mode></code></pre> </div></div> -<div class="paragraph"><p>The <tt>mode <mode>,<mode>..<mode></tt> line appears only if at least one of +<div class="paragraph"><p>The <code>mode <mode>,<mode>..<mode></code> line appears only if at least one of the <mode> is different from the rest. Extended headers with information about detected contents movement (renames and copying detection) are designed to work with diff of two @@ -1856,74 +2041,76 @@ </p> <div class="literalblock"> <div class="content"> -<pre><tt>--- a/file -+++ b/file</tt></pre> +<pre><code>--- a/file ++++ b/file</code></pre> </div></div> <div class="paragraph"><p>Similar to two-line header for traditional <em>unified</em> diff -format, <tt>/dev/null</tt> is used to signal created or deleted +format, <code>/dev/null</code> is used to signal created or deleted files.</p></div> </li> <li> <p> Chunk header format is modified to prevent people from - accidentally feeding it to <tt>patch -p1</tt>. Combined diff format + accidentally feeding it to <code>patch -p1</code>. Combined diff format was created for review of merge commit changes, and was not meant for apply. The change is similar to the change in the extended <em>index</em> header: </p> <div class="literalblock"> <div class="content"> -<pre><tt>@@@ <from-file-range> <from-file-range> <to-file-range> @@@</tt></pre> +<pre><code>@@@ <from-file-range> <from-file-range> <to-file-range> @@@</code></pre> </div></div> -<div class="paragraph"><p>There are (number of parents + 1) <tt>@</tt> characters in the chunk +<div class="paragraph"><p>There are (number of parents + 1) <code>@</code> characters in the chunk header for combined diff format.</p></div> </li> </ol></div> <div class="paragraph"><p>Unlike the traditional <em>unified</em> diff format, which shows two -files A and B with a single column that has <tt>-</tt> (minus — appears in A but removed in B), <tt>+</tt> (plus — missing in A but -added to B), or <tt>" "</tt> (space — unchanged) prefix, this format +files A and B with a single column that has <code>-</code> (minus — appears in A but removed in B), <code>+</code> (plus — missing in A but +added to B), or <code>" "</code> (space — unchanged) prefix, this format compares two or more files file1, file2,… with one file X, and shows how X differs from each of fileN. One column for each of fileN is prepended to the output line to note how X’s line is different from it.</p></div> -<div class="paragraph"><p>A <tt>-</tt> character in the column N means that the line appears in -fileN but it does not appear in the result. A <tt>+</tt> character +<div class="paragraph"><p>A <code>-</code> character in the column N means that the line appears in +fileN but it does not appear in the result. A <code>+</code> character in the column N means that the line appears in the result, and fileN does not have that line (in other words, the line was added, from the point of view of that parent).</p></div> <div class="paragraph"><p>In the above example output, the function signature was changed -from both files (hence two <tt>-</tt> removals from both file1 and -file2, plus <tt>++</tt> to mean one line that was added does not appear +from both files (hence two <code>-</code> removals from both file1 and +file2, plus <code>++</code> to mean one line that was added does not appear in either file1 nor file2). Also eight other lines are the same -from file1 but do not appear in file2 (hence prefixed with <tt>+</tt>).</p></div> -<div class="paragraph"><p>When shown by <tt>git diff-tree -c</tt>, it compares the parents of a +from file1 but do not appear in file2 (hence prefixed with <code>+</code>).</p></div> +<div class="paragraph"><p>When shown by <code>git diff-tree -c</code>, it compares the parents of a merge commit with the merge result (i.e. file1..fileN are the -parents). When shown by <tt>git diff-files -c</tt>, it compares the +parents). When shown by <code>git diff-files -c</code>, it compares the two unresolved merge parents with the working tree file (i.e. file1 is stage 2 aka "our version", file2 is stage 3 aka "their version").</p></div> </div> +</div> +<div class="sect1"> <h2 id="_other_diff_formats">other diff formats</h2> <div class="sectionbody"> -<div class="paragraph"><p>The <tt>--summary</tt> option describes newly added, deleted, renamed and -copied files. The <tt>--stat</tt> option adds diffstat(1) graph to the +<div class="paragraph"><p>The <code>--summary</code> option describes newly added, deleted, renamed and +copied files. The <code>--stat</code> option adds diffstat(1) graph to the output. These options can be combined with other options, such as -<tt>-p</tt>, and are meant for human consumption.</p></div> -<div class="paragraph"><p>When showing a change that involves a rename or a copy, <tt>--stat</tt> output +<code>-p</code>, and are meant for human consumption.</p></div> +<div class="paragraph"><p>When showing a change that involves a rename or a copy, <code>--stat</code> output formats the pathnames compactly by combining common prefix and suffix of -the pathnames. For example, a change that moves <tt>arch/i386/Makefile</tt> to -<tt>arch/x86/Makefile</tt> while modifying 4 lines will be shown like this:</p></div> +the pathnames. For example, a change that moves <code>arch/i386/Makefile</code> to +<code>arch/x86/Makefile</code> while modifying 4 lines will be shown like this:</p></div> <div class="listingblock"> <div class="content"> -<pre><tt>arch/{i386 => x86}/Makefile | 4 +--</tt></pre> +<pre><code>arch/{i386 => x86}/Makefile | 4 +--</code></pre> </div></div> -<div class="paragraph"><p>The <tt>--numstat</tt> option gives the diffstat(1) information but is designed -for easier machine consumption. An entry in <tt>--numstat</tt> output looks +<div class="paragraph"><p>The <code>--numstat</code> option gives the diffstat(1) information but is designed +for easier machine consumption. An entry in <code>--numstat</code> output looks like this:</p></div> <div class="listingblock"> <div class="content"> -<pre><tt>1 2 README -3 1 arch/{i386 => x86}/Makefile</tt></pre> +<pre><code>1 2 README +3 1 arch/{i386 => x86}/Makefile</code></pre> </div></div> <div class="paragraph"><p>That is, from left to right:</p></div> <div class="olist arabic"><ol class="arabic"> @@ -1958,11 +2145,11 @@ </p> </li> </ol></div> -<div class="paragraph"><p>When <tt>-z</tt> output option is in effect, the output is formatted this way:</p></div> +<div class="paragraph"><p>When <code>-z</code> output option is in effect, the output is formatted this way:</p></div> <div class="listingblock"> <div class="content"> -<pre><tt>1 2 README NUL -3 1 NUL arch/i386/Makefile NUL arch/x86/Makefile NUL</tt></pre> +<pre><code>1 2 README NUL +3 1 NUL arch/i386/Makefile NUL arch/x86/Makefile NUL</code></pre> </div></div> <div class="paragraph"><p>That is:</p></div> <div class="olist arabic"><ol class="arabic"> @@ -2012,12 +2199,14 @@ </p> </li> </ol></div> -<div class="paragraph"><p>The extra <tt>NUL</tt> before the preimage path in renamed case is to allow +<div class="paragraph"><p>The extra <code>NUL</code> before the preimage path in renamed case is to allow scripts that read the output to tell if the current record being read is a single-path record or a rename/copy record without reading ahead. -After reading added and deleted lines, reading up to <tt>NUL</tt> would yield -the pathname, but if that is <tt>NUL</tt>, the record will show two paths.</p></div> +After reading added and deleted lines, reading up to <code>NUL</code> would yield +the pathname, but if that is <code>NUL</code>, the record will show two paths.</p></div> </div> +</div> +<div class="sect1"> <h2 id="_examples">EXAMPLES</h2> <div class="sectionbody"> <div class="dlist"><dl> @@ -2027,9 +2216,9 @@ <dd> <div class="listingblock"> <div class="content"> -<pre><tt>$ git diff <b><1></b> +<pre><code>$ git diff <b><1></b> $ git diff --cached <b><2></b> -$ git diff HEAD <b><3></b></tt></pre> +$ git diff HEAD <b><3></b></code></pre> </div></div> <div class="colist arabic"><ol> <li> @@ -2057,9 +2246,9 @@ <dd> <div class="listingblock"> <div class="content"> -<pre><tt>$ git diff test <b><1></b> +<pre><code>$ git diff test <b><1></b> $ git diff HEAD -- ./test <b><2></b> -$ git diff HEAD^ HEAD <b><3></b></tt></pre> +$ git diff HEAD^ HEAD <b><3></b></code></pre> </div></div> <div class="colist arabic"><ol> <li> @@ -2088,9 +2277,9 @@ <dd> <div class="listingblock"> <div class="content"> -<pre><tt>$ git diff topic master <b><1></b> +<pre><code>$ git diff topic master <b><1></b> $ git diff topic..master <b><2></b> -$ git diff topic...master <b><3></b></tt></pre> +$ git diff topic...master <b><3></b></code></pre> </div></div> <div class="colist arabic"><ol> <li> @@ -2117,9 +2306,9 @@ <dd> <div class="listingblock"> <div class="content"> -<pre><tt>$ git diff --diff-filter=MRC <b><1></b> +<pre><code>$ git diff --diff-filter=MRC <b><1></b> $ git diff --name-status <b><2></b> -$ git diff arch/i386 include/asm-i386 <b><3></b></tt></pre> +$ git diff arch/i386 include/asm-i386 <b><3></b></code></pre> </div></div> <div class="colist arabic"><ol> <li> @@ -2147,8 +2336,8 @@ <dd> <div class="listingblock"> <div class="content"> -<pre><tt>$ git diff --find-copies-harder -B -C <b><1></b> -$ git diff -R <b><2></b></tt></pre> +<pre><code>$ git diff --find-copies-harder -B -C <b><1></b> +$ git diff -R <b><2></b></code></pre> </div></div> <div class="colist arabic"><ol> <li> @@ -2166,6 +2355,8 @@ </dd> </dl></div> </div> +</div> +<div class="sect1"> <h2 id="_see_also">SEE ALSO</h2> <div class="sectionbody"> <div class="paragraph"><p>diff(1), @@ -2175,15 +2366,18 @@ <a href="git-format-patch.html">git-format-patch(1)</a>, <a href="git-apply.html">git-apply(1)</a></p></div> </div> +</div> +<div class="sect1"> <h2 id="_git">GIT</h2> <div class="sectionbody"> <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div> </div> </div> +</div> <div id="footnotes"><hr /></div> <div id="footer"> <div id="footer-text"> -Last updated 2011-11-15 13:45:02 PDT +Last updated 2011-11-15 13:45:02 PST </div> </div> </body> diff --git a/git-format-patch.html b/git-format-patch.html index 60107a5..dbb219e 100644 --- a/git-format-patch.html +++ b/git-format-patch.html
@@ -2,15 +2,25 @@ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> <head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> -<meta name="generator" content="AsciiDoc 8.5.2" /> +<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" /> +<meta name="generator" content="AsciiDoc 8.6.8" /> <title>git-format-patch(1)</title> <style type="text/css"> -/* Debug borders */ -p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 { -/* - border: 1px solid red; -*/ +/* Shared CSS for AsciiDoc xhtml11 and html5 backends */ + +/* Default font. */ +body { + font-family: Georgia,serif; +} + +/* Title font. */ +h1, h2, h3, h4, h5, h6, +div.title, caption.title, +thead, p.table.header, +#toctitle, +#author, #revnumber, #revdate, #revremark, +#footer { + font-family: Arial,Helvetica,sans-serif; } body { @@ -35,13 +45,8 @@ color: #083194; } -tt { - color: navy; -} - h1, h2, h3, h4, h5, h6 { color: #527bbd; - font-family: sans-serif; margin-top: 1.2em; margin-bottom: 0.5em; line-height: 1.3; @@ -59,9 +64,11 @@ h3 + * { clear: left; } +h5 { + font-size: 1.0em; +} div.sectionbody { - font-family: serif; margin-left: 0; } @@ -77,45 +84,48 @@ ul, ol, li > p { margin-top: 0; } +ul > li { color: #aaa; } +ul > li > * { color: black; } -pre { +.monospaced, code, pre { + font-family: "Courier New", Courier, monospace; + font-size: inherit; + color: navy; padding: 0; margin: 0; } -span#author { + +#author { color: #527bbd; - font-family: sans-serif; font-weight: bold; font-size: 1.1em; } -span#email { +#email { } -span#revnumber, span#revdate, span#revremark { - font-family: sans-serif; +#revnumber, #revdate, #revremark { } -div#footer { - font-family: sans-serif; +#footer { font-size: small; border-top: 2px solid silver; padding-top: 0.5em; margin-top: 4.0em; } -div#footer-text { +#footer-text { float: left; padding-bottom: 0.5em; } -div#footer-badges { +#footer-badges { float: right; padding-bottom: 0.5em; } -div#preamble { +#preamble { margin-top: 1.5em; margin-bottom: 1.5em; } -div.tableblock, div.imageblock, div.exampleblock, div.verseblock, +div.imageblock, div.exampleblock, div.verseblock, div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock, div.admonitionblock { margin-top: 1.0em; @@ -135,7 +145,6 @@ /* Block element titles. */ div.title, caption.title { color: #527bbd; - font-family: sans-serif; font-weight: bold; text-align: left; margin-top: 1.0em; @@ -157,13 +166,15 @@ div.sidebarblock > div.content { background: #ffffee; - border: 1px solid silver; + border: 1px solid #dddddd; + border-left: 4px solid #f0f0f0; padding: 0.5em; } div.listingblock > div.content { - border: 1px solid silver; - background: #f4f4f4; + border: 1px solid #dddddd; + border-left: 5px solid #f0f0f0; + background: #f8f8f8; padding: 0.5em; } @@ -171,8 +182,8 @@ padding-left: 1.0em; margin-left: 1.0em; margin-right: 10%; - border-left: 5px solid #dddddd; - color: #777777; + border-left: 5px solid #f0f0f0; + color: #888; } div.quoteblock > div.attribution { @@ -180,8 +191,9 @@ text-align: right; } -div.verseblock > div.content { - white-space: pre; +div.verseblock > pre.content { + font-family: inherit; + font-size: inherit; } div.verseblock > div.attribution { padding-top: 0.75em; @@ -254,35 +266,12 @@ margin-bottom: 0.1em; } -div.tableblock > table { - border: 3px solid #527bbd; -} -thead, p.table.header { - font-family: sans-serif; - font-weight: bold; -} tfoot { font-weight: bold; } td > div.verse { white-space: pre; } -p.table { - margin-top: 0; -} -/* Because the table frame attribute is overriden by CSS in most browsers. */ -div.tableblock > table[frame="void"] { - border-style: none; -} -div.tableblock > table[frame="hsides"] { - border-left-style: none; - border-right-style: none; -} -div.tableblock > table[frame="vsides"] { - border-top-style: none; - border-bottom-style: none; -} - div.hdlist { margin-top: 0.8em; @@ -339,25 +328,32 @@ min-width: 100px; } - -@media print { - div#footer-badges { display: none; } +div.colist td { + padding-right: 0.5em; + padding-bottom: 0.3em; + vertical-align: top; +} +div.colist td img { + margin-top: 0.3em; } -div#toc { +@media print { + #footer-badges { display: none; } +} + +#toc { margin-bottom: 2.5em; } -div#toctitle { +#toctitle { color: #527bbd; - font-family: sans-serif; font-size: 1.1em; font-weight: bold; margin-top: 1.0em; margin-bottom: 0.1em; } -div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 { +div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 { margin-top: 0; margin-bottom: 0; } @@ -373,69 +369,173 @@ margin-left: 6em; font-size: 0.9em; } -/* Overrides for manpage documents */ -h1 { + +span.aqua { color: aqua; } +span.black { color: black; } +span.blue { color: blue; } +span.fuchsia { color: fuchsia; } +span.gray { color: gray; } +span.green { color: green; } +span.lime { color: lime; } +span.maroon { color: maroon; } +span.navy { color: navy; } +span.olive { color: olive; } +span.purple { color: purple; } +span.red { color: red; } +span.silver { color: silver; } +span.teal { color: teal; } +span.white { color: white; } +span.yellow { color: yellow; } + +span.aqua-background { background: aqua; } +span.black-background { background: black; } +span.blue-background { background: blue; } +span.fuchsia-background { background: fuchsia; } +span.gray-background { background: gray; } +span.green-background { background: green; } +span.lime-background { background: lime; } +span.maroon-background { background: maroon; } +span.navy-background { background: navy; } +span.olive-background { background: olive; } +span.purple-background { background: purple; } +span.red-background { background: red; } +span.silver-background { background: silver; } +span.teal-background { background: teal; } +span.white-background { background: white; } +span.yellow-background { background: yellow; } + +span.big { font-size: 2em; } +span.small { font-size: 0.6em; } + +span.underline { text-decoration: underline; } +span.overline { text-decoration: overline; } +span.line-through { text-decoration: line-through; } + +div.unbreakable { page-break-inside: avoid; } + + +/* + * xhtml11 specific + * + * */ + +div.tableblock { + margin-top: 1.0em; + margin-bottom: 1.5em; +} +div.tableblock > table { + border: 3px solid #527bbd; +} +thead, p.table.header { + font-weight: bold; + color: #527bbd; +} +p.table { + margin-top: 0; +} +/* Because the table frame attribute is overriden by CSS in most browsers. */ +div.tableblock > table[frame="void"] { + border-style: none; +} +div.tableblock > table[frame="hsides"] { + border-left-style: none; + border-right-style: none; +} +div.tableblock > table[frame="vsides"] { + border-top-style: none; + border-bottom-style: none; +} + + +/* + * html5 specific + * + * */ + +table.tableblock { + margin-top: 1.0em; + margin-bottom: 1.5em; +} +thead, p.tableblock.header { + font-weight: bold; + color: #527bbd; +} +p.tableblock { + margin-top: 0; +} +table.tableblock { + border-width: 3px; + border-spacing: 0px; + border-style: solid; + border-color: #527bbd; + border-collapse: collapse; +} +th.tableblock, td.tableblock { + border-width: 1px; + padding: 4px; + border-style: solid; + border-color: #527bbd; +} + +table.tableblock.frame-topbot { + border-left-style: hidden; + border-right-style: hidden; +} +table.tableblock.frame-sides { + border-top-style: hidden; + border-bottom-style: hidden; +} +table.tableblock.frame-none { + border-style: hidden; +} + +th.tableblock.halign-left, td.tableblock.halign-left { + text-align: left; +} +th.tableblock.halign-center, td.tableblock.halign-center { + text-align: center; +} +th.tableblock.halign-right, td.tableblock.halign-right { + text-align: right; +} + +th.tableblock.valign-top, td.tableblock.valign-top { + vertical-align: top; +} +th.tableblock.valign-middle, td.tableblock.valign-middle { + vertical-align: middle; +} +th.tableblock.valign-bottom, td.tableblock.valign-bottom { + vertical-align: bottom; +} + + +/* + * manpage specific + * + * */ + +body.manpage h1 { padding-top: 0.5em; padding-bottom: 0.5em; border-top: 2px solid silver; border-bottom: 2px solid silver; } -h2 { +body.manpage h2 { border-style: none; } -div.sectionbody { - margin-left: 5%; +body.manpage div.sectionbody { + margin-left: 3em; } @media print { - div#toc { display: none; } + body.manpage div#toc { display: none; } } -/* Workarounds for IE6's broken and incomplete CSS2. */ -div.sidebar-content { - background: #ffffee; - border: 1px solid silver; - padding: 0.5em; -} -div.sidebar-title, div.image-title { - color: #527bbd; - font-family: sans-serif; - font-weight: bold; - margin-top: 0.0em; - margin-bottom: 0.5em; -} - -div.listingblock div.content { - border: 1px solid silver; - background: #f4f4f4; - padding: 0.5em; -} - -div.quoteblock-attribution { - padding-top: 0.5em; - text-align: right; -} - -div.verseblock-content { - white-space: pre; -} -div.verseblock-attribution { - padding-top: 0.75em; - text-align: left; -} - -div.exampleblock-content { - border-left: 3px solid #dddddd; - padding-left: 0.5em; -} - -/* IE6 sets dynamically generated links as visited. */ -div#toc a:visited { color: blue; } </style> <script type="text/javascript"> /*<+'])'); + var re = new RegExp('[hH]([1-'+(toclevels+1)+'])'); // Function that scans the DOM tree for header elements (the DOM2 // nodeIterator API would be a better technique but not supported by all // browsers). @@ -497,6 +597,25 @@ } var toc = document.getElementById("toc"); + if (!toc) { + return; + } + + // Delete existing TOC entries in case we're reloading the TOC. + var tocEntriesToRemove = []; + var i; + for (i = 0; i < toc.childNodes.length; i++) { + var entry = toc.childNodes[i]; + if (entry.nodeName.toLowerCase() == 'div' + && entry.getAttribute("class") + && entry.getAttribute("class").match(/^toclevel/)) + tocEntriesToRemove.push(entry); + } + for (i = 0; i < tocEntriesToRemove.length; i++) { + toc.removeChild(tocEntriesToRemove[i]); + } + + // Rebuild TOC entries. var entries = tocEntries(document.getElementById("content"), toclevels); for (var i = 0; i < entries.length; ++i) { var entry = entries[i]; @@ -524,24 +643,44 @@ */ footnotes: function () { - var cont = document.getElementById("content"); + // Delete existing footnote entries in case we're reloading the footnodes. + var i; var noteholder = document.getElementById("footnotes"); + if (!noteholder) { + return; + } + var entriesToRemove = []; + for (i = 0; i < noteholder.childNodes.length; i++) { + var entry = noteholder.childNodes[i]; + if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote") + entriesToRemove.push(entry); + } + for (i = 0; i < entriesToRemove.length; i++) { + noteholder.removeChild(entriesToRemove[i]); + } + + // Rebuild footnote entries. + var cont = document.getElementById("content"); var spans = cont.getElementsByTagName("span"); var refs = {}; var n = 0; for (i=0; i<spans.length; i++) { if (spans[i].className == "footnote") { n++; - // Use [\s\S] in place of . so multi-line matches work. - // Because JavaScript has no s (dotall) regex flag. - note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1]; + var note = spans[i].getAttribute("data-note"); + if (!note) { + // Use [\s\S] in place of . so multi-line matches work. + // Because JavaScript has no s (dotall) regex flag. + note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1]; + spans[i].innerHTML = + "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n + + "' title='View footnote' class='footnote'>" + n + "</a>]"; + spans[i].setAttribute("data-note", note); + } noteholder.innerHTML += "<div class='footnote' id='_footnote_" + n + "'>" + "<a href='#_footnoteref_" + n + "' title='Return to text'>" + n + "</a>. " + note + "</div>"; - spans[i].innerHTML = - "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n + - "' title='View footnote' class='footnote'>" + n + "</a>]"; var id =spans[i].getAttribute("id"); if (id != null) refs["#"+id] = n; } @@ -561,13 +700,36 @@ } } } +}, + +install: function(toclevels) { + var timerId; + + function reinstall() { + asciidoc.footnotes(); + if (toclevels) { + asciidoc.toc(toclevels); + } + } + + function reinstallAndRemoveTimer() { + clearInterval(timerId); + reinstall(); + } + + timerId = setInterval(reinstall, 500); + if (document.addEventListener) + document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false); + else + window.onload = reinstallAndRemoveTimer; } } +asciidoc.install(); /*]]>*/ </script> </head> -<body> +<body class="manpage"> <div id="header"> <h1> git-format-patch(1) Manual Page @@ -580,10 +742,11 @@ </div> </div> <div id="content"> +<div class="sect1"> <h2 id="_synopsis">SYNOPSIS</h2> <div class="sectionbody"> <div class="verseblock"> -<div class="verseblock-content"><em>git format-patch</em> [-k] [(-o|--output-directory) <dir> | --stdout] +<pre class="content"><em>git format-patch</em> [-k] [(-o|--output-directory) <dir> | --stdout] [--no-thread | --thread[=<style>]] [(--attach|--inline)[=<boundary>] | --no-attach] [-s | --signoff] @@ -596,10 +759,12 @@ [--to=<email>] [--cc=<email>] [--cover-letter] [--quiet] [--notes[=<ref>]] [<common diff options>] - [ <since> | <revision range> ]</div> -<div class="verseblock-attribution"> + [ <since> | <revision range> ]</pre> +<div class="attribution"> </div></div> </div> +</div> +<div class="sect1"> <h2 id="_description">DESCRIPTION</h2> <div class="sectionbody"> <div class="paragraph"><p>Prepare each commit with its patch in @@ -625,28 +790,30 @@ </ol></div> <div class="paragraph"><p>The first rule takes precedence in the case of a single <commit>. To apply the second rule, i.e., format everything since the beginning of -history up until <commit>, use the <em>--root</em> option: <tt>git format-patch ---root <commit></tt>. If you want to format only <commit> itself, you -can do this with <tt>git format-patch -1 <commit></tt>.</p></div> +history up until <commit>, use the <em>--root</em> option: <code>git format-patch +--root <commit></code>. If you want to format only <commit> itself, you +can do this with <code>git format-patch -1 <commit></code>.</p></div> <div class="paragraph"><p>By default, each output file is numbered sequentially from 1, and uses the first line of the commit message (massaged for pathname safety) as -the filename. With the <tt>--numbered-files</tt> option, the output file names +the filename. With the <code>--numbered-files</code> option, the output file names will only be numbers, without the first line of the commit appended. The names of the output files are printed to standard -output, unless the <tt>--stdout</tt> option is specified.</p></div> -<div class="paragraph"><p>If <tt>-o</tt> is specified, output files are created in <dir>. Otherwise +output, unless the <code>--stdout</code> option is specified.</p></div> +<div class="paragraph"><p>If <code>-o</code> is specified, output files are created in <dir>. Otherwise they are created in the current working directory.</p></div> <div class="paragraph"><p>By default, the subject of a single patch is "[PATCH] " followed by the concatenation of lines from the commit message up to the first blank line (see the DISCUSSION section of <a href="git-commit.html">git-commit(1)</a>).</p></div> <div class="paragraph"><p>When multiple patches are output, the subject prefix will instead be -"[PATCH n/m] ". To force 1/1 to be added for a single patch, use <tt>-n</tt>. -To omit patch numbers from the subject, use <tt>-N</tt>.</p></div> -<div class="paragraph"><p>If given <tt>--thread</tt>, <tt>git-format-patch</tt> will generate <tt>In-Reply-To</tt> and -<tt>References</tt> headers to make the second and subsequent patch mails appear -as replies to the first mail; this also generates a <tt>Message-Id</tt> header to +"[PATCH n/m] ". To force 1/1 to be added for a single patch, use <code>-n</code>. +To omit patch numbers from the subject, use <code>-N</code>.</p></div> +<div class="paragraph"><p>If given <code>--thread</code>, <code>git-format-patch</code> will generate <code>In-Reply-To</code> and +<code>References</code> headers to make the second and subsequent patch mails appear +as replies to the first mail; this also generates a <code>Message-Id</code> header to reference.</p></div> </div> +</div> +<div class="sect1"> <h2 id="_options">OPTIONS</h2> <div class="sectionbody"> <div class="dlist"><dl> @@ -707,29 +874,29 @@ will be used for the filename part, and the rest for the graph part. Maximum width defaults to terminal width, or 80 columns if not connected to a terminal, and can be overridden by - <tt><width></tt>. The width of the filename part can be limited by - giving another width <tt><name-width></tt> after a comma. The width + <code><width></code>. The width of the filename part can be limited by + giving another width <code><name-width></code> after a comma. The width of the graph part can be limited by using - <tt>--stat-graph-width=<width></tt> (affects all commands generating - a stat graph) or by setting <tt>diff.statGraphWidth=<width></tt> - (does not affect <tt>git format-patch</tt>). - By giving a third parameter <tt><count></tt>, you can limit the - output to the first <tt><count></tt> lines, followed by <tt>...</tt> if + <code>--stat-graph-width=<width></code> (affects all commands generating + a stat graph) or by setting <code>diff.statGraphWidth=<width></code> + (does not affect <code>git format-patch</code>). + By giving a third parameter <code><count></code>, you can limit the + output to the first <code><count></code> lines, followed by <code>...</code> if there are more. </p> -<div class="paragraph"><p>These parameters can also be set individually with <tt>--stat-width=<width></tt>, -<tt>--stat-name-width=<name-width></tt> and <tt>--stat-count=<count></tt>.</p></div> +<div class="paragraph"><p>These parameters can also be set individually with <code>--stat-width=<width></code>, +<code>--stat-name-width=<name-width></code> and <code>--stat-count=<count></code>.</p></div> </dd> <dt class="hdlist1"> --numstat </dt> <dd> <p> - Similar to <tt>--stat</tt>, but shows number of added and + Similar to <code>--stat</code>, but shows number of added and deleted lines in decimal notation and pathname without abbreviation, to make it more machine friendly. For - binary files, outputs two <tt>-</tt> instead of saying - <tt>0 0</tt>. + binary files, outputs two <code>-</code> instead of saying + <code>0 0</code>. </p> </dd> <dt class="hdlist1"> @@ -737,7 +904,7 @@ </dt> <dd> <p> - Output only the last line of the <tt>--stat</tt> format containing total + Output only the last line of the <code>--stat</code> format containing total number of modified files, as well as number of added and deleted lines. </p> @@ -748,15 +915,17 @@ <dd> <p> Output the distribution of relative amount of changes for each - sub-directory. The behavior of <tt>--dirstat</tt> can be customized by + sub-directory. The behavior of <code>--dirstat</code> can be customized by passing it a comma separated list of parameters. - The defaults are controlled by the <tt>diff.dirstat</tt> configuration + The defaults are controlled by the <code>diff.dirstat</code> configuration variable (see <a href="git-config.html">git-config(1)</a>). The following parameters are available: </p> +<div class="openblock"> +<div class="content"> <div class="dlist"><dl> <dt class="hdlist1"> -<tt>changes</tt> +<code>changes</code> </dt> <dd> <p> @@ -768,39 +937,39 @@ </p> </dd> <dt class="hdlist1"> -<tt>lines</tt> +<code>lines</code> </dt> <dd> <p> Compute the dirstat numbers by doing the regular line-based diff analysis, and summing the removed/added line counts. (For binary files, count 64-byte chunks instead, since binary files have no - natural concept of lines). This is a more expensive <tt>--dirstat</tt> - behavior than the <tt>changes</tt> behavior, but it does count rearranged + natural concept of lines). This is a more expensive <code>--dirstat</code> + behavior than the <code>changes</code> behavior, but it does count rearranged lines within a file as much as other changes. The resulting output - is consistent with what you get from the other <tt>--*stat</tt> options. + is consistent with what you get from the other <code>--*stat</code> options. </p> </dd> <dt class="hdlist1"> -<tt>files</tt> +<code>files</code> </dt> <dd> <p> Compute the dirstat numbers by counting the number of files changed. Each changed file counts equally in the dirstat analysis. This is - the computationally cheapest <tt>--dirstat</tt> behavior, since it does + the computationally cheapest <code>--dirstat</code> behavior, since it does not have to look at the file contents at all. </p> </dd> <dt class="hdlist1"> -<tt>cumulative</tt> +<code>cumulative</code> </dt> <dd> <p> Count changes in a child directory for the parent directory as well. - Note that when using <tt>cumulative</tt>, the sum of the percentages + Note that when using <code>cumulative</code>, the sum of the percentages reported may exceed 100%. The default (non-cumulative) behavior can - be specified with the <tt>noncumulative</tt> parameter. + be specified with the <code>noncumulative</code> parameter. </p> </dd> <dt class="hdlist1"> @@ -814,10 +983,11 @@ </p> </dd> </dl></div> +</div></div> <div class="paragraph"><p>Example: The following will count changed files, while ignoring directories with less than 10% of the total amount of changed files, and accumulating child directory counts in the parent directories: -<tt>--dirstat=files,10,cumulative</tt>.</p></div> +<code>--dirstat=files,10,cumulative</code>.</p></div> </dd> <dt class="hdlist1"> --summary @@ -852,8 +1022,8 @@ </dt> <dd> <p> - In addition to <tt>--full-index</tt>, output a binary diff that - can be applied with <tt>git-apply</tt>. + In addition to <code>--full-index</code>, output a binary diff that + can be applied with <code>git-apply</code>. </p> </dd> <dt class="hdlist1"> @@ -864,9 +1034,9 @@ Instead of showing the full 40-byte hexadecimal object name in diff-raw format output and diff-tree header lines, show only a partial prefix. This is - independent of the <tt>--full-index</tt> option above, which controls + independent of the <code>--full-index</code> option above, which controls the diff-patch output format. Non default number of - digits can be specified with <tt>--abbrev=<n></tt>. + digits can be specified with <code>--abbrev=<n></code>. </p> </dd> <dt class="hdlist1"> @@ -884,15 +1054,15 @@ not as a series of deletion and insertion mixed together with a very few lines that happen to match textually as the context, but as a single deletion of everything old followed by a single insertion of -everything new, and the number <tt>m</tt> controls this aspect of the -B -option (defaults to 60%). <tt>-B/70%</tt> specifies that less than 30% of the +everything new, and the number <code>m</code> controls this aspect of the -B +option (defaults to 60%). <code>-B/70%</code> specifies that less than 30% of the original should remain in the result for git to consider it a total rewrite (i.e. otherwise the resulting patch will be a series of deletion and insertion mixed together with context lines).</p></div> <div class="paragraph"><p>When used with -M, a totally-rewritten file is also considered as the source of a rename (usually -M only considers a file that disappeared -as the source of a rename), and the number <tt>n</tt> controls this aspect of -the -B option (defaults to 50%). <tt>-B20%</tt> specifies that a change with +as the source of a rename), and the number <code>n</code> controls this aspect of +the -B option (defaults to 50%). <code>-B20%</code> specifies that a change with addition and deletion compared to 20% or more of the file’s size are eligible for being picked up as a possible source of a rename to another file.</p></div> @@ -906,11 +1076,15 @@ <dd> <p> Detect renames. - If <tt>n</tt> is specified, it is a threshold on the similarity + If <code>n</code> is specified, it is a threshold on the similarity index (i.e. amount of addition/deletions compared to the - file’s size). For example, <tt>-M90%</tt> means git should consider a + file’s size). For example, <code>-M90%</code> means git should consider a delete/add pair to be a rename if more than 90% of the file - hasn’t changed. + hasn’t changed. Without a <code>%</code> sign, the number is to be read as + a fraction, with a decimal point before it. I.e., <code>-M5</code> becomes + 0.5, and is thus the same as <code>-M50%</code>. Similarly, <code>-M05</code> is + the same as <code>-M5%</code>. To limit detection to exact renames, use + <code>-M100%</code>. </p> </dd> <dt class="hdlist1"> @@ -921,8 +1095,8 @@ </dt> <dd> <p> - Detect copies as well as renames. See also <tt>--find-copies-harder</tt>. - If <tt>n</tt> is specified, it has the same meaning as for <tt>-M<n></tt>. + Detect copies as well as renames. See also <code>--find-copies-harder</code>. + If <code>n</code> is specified, it has the same meaning as for <code>-M<n></code>. </p> </dd> <dt class="hdlist1"> @@ -930,13 +1104,13 @@ </dt> <dd> <p> - For performance reasons, by default, <tt>-C</tt> option finds copies only + For performance reasons, by default, <code>-C</code> option finds copies only if the original file of the copy was modified in the same changeset. This flag makes the command inspect unmodified files as candidates for the source of copy. This is a very expensive operation for large projects, so use it with caution. Giving more than one - <tt>-C</tt> option has the same effect. + <code>-C</code> option has the same effect. </p> </dd> <dt class="hdlist1"> @@ -948,14 +1122,14 @@ <dd> <p> Omit the preimage for deletes, i.e. print only the header but not - the diff between the preimage and <tt>/dev/null</tt>. The resulting patch - is not meant to be applied with <tt>patch</tt> nor <tt>git apply</tt>; this is + the diff between the preimage and <code>/dev/null</code>. The resulting patch + is not meant to be applied with <code>patch</code> nor <code>git apply</code>; this is solely for people who want to just concentrate on reviewing the text after the change. In addition, the output obviously lack enough information to apply such a patch in reverse, even manually, hence the name of the option. </p> -<div class="paragraph"><p>When used together with <tt>-B</tt>, omit also the preimage in the deletion part +<div class="paragraph"><p>When used together with <code>-B</code>, omit also the preimage in the deletion part of a delete/create pair.</p></div> </dd> <dt class="hdlist1"> @@ -963,7 +1137,7 @@ </dt> <dd> <p> - The <tt>-M</tt> and <tt>-C</tt> options require O(n^2) processing time where n + The <code>-M</code> and <code>-C</code> options require O(n^2) processing time where n is the number of potential rename/copy targets. This option prevents rename/copy detection from running if the number of rename/copy targets exceeds the specified @@ -1205,7 +1379,7 @@ </dt> <dd> <p> - Add <tt>Signed-off-by:</tt> line to the commit message, using + Add <code>Signed-off-by:</code> line to the commit message, using the committer identity of yourself. </p> </dd> @@ -1225,7 +1399,7 @@ <p> Create multipart/mixed attachment, the first part of which is the commit message and the patch itself in the - second part, with <tt>Content-Disposition: attachment</tt>. + second part, with <code>Content-Disposition: attachment</code>. </p> </dd> <dt class="hdlist1"> @@ -1244,7 +1418,7 @@ <p> Create multipart/mixed attachment, the first part of which is the commit message and the patch itself in the - second part, with <tt>Content-Disposition: inline</tt>. + second part, with <code>Content-Disposition: inline</code>. </p> </dd> <dt class="hdlist1"> @@ -1255,29 +1429,29 @@ </dt> <dd> <p> - Controls addition of <tt>In-Reply-To</tt> and <tt>References</tt> headers to + Controls addition of <code>In-Reply-To</code> and <code>References</code> headers to make the second and subsequent mails appear as replies to the - first. Also controls generation of the <tt>Message-Id</tt> header to + first. Also controls generation of the <code>Message-Id</code> header to reference. </p> -<div class="paragraph"><p>The optional <style> argument can be either <tt>shallow</tt> or <tt>deep</tt>. +<div class="paragraph"><p>The optional <style> argument can be either <code>shallow</code> or <code>deep</code>. <em>shallow</em> threading makes every mail a reply to the head of the series, where the head is chosen from the cover letter, the -<tt>--in-reply-to</tt>, and the first patch mail, in this order. <em>deep</em> +<code>--in-reply-to</code>, and the first patch mail, in this order. <em>deep</em> threading makes every mail a reply to the previous one.</p></div> -<div class="paragraph"><p>The default is <tt>--no-thread</tt>, unless the <em>format.thread</em> configuration -is set. If <tt>--thread</tt> is specified without a style, it defaults to the -style specified by <em>format.thread</em> if any, or else <tt>shallow</tt>.</p></div> +<div class="paragraph"><p>The default is <code>--no-thread</code>, unless the <em>format.thread</em> configuration +is set. If <code>--thread</code> is specified without a style, it defaults to the +style specified by <em>format.thread</em> if any, or else <code>shallow</code>.</p></div> <div class="paragraph"><p>Beware that the default for <em>git send-email</em> is to thread emails -itself. If you want <tt>git format-patch</tt> to take care of threading, you -will want to ensure that threading is disabled for <tt>git send-email</tt>.</p></div> +itself. If you want <code>git format-patch</code> to take care of threading, you +will want to ensure that threading is disabled for <code>git send-email</code>.</p></div> </dd> <dt class="hdlist1"> --in-reply-to=Message-Id </dt> <dd> <p> - Make the first mail (or all the mails with <tt>--no-thread</tt>) appear as a + Make the first mail (or all the mails with <code>--no-thread</code>) appear as a reply to the given Message-Id, which avoids breaking threads to provide a new patch series. </p> @@ -1302,7 +1476,7 @@ Instead of the standard <em>[PATCH]</em> prefix in the subject line, instead use <em>[<Subject-Prefix>]</em>. This allows for useful naming of a patch series, and can be - combined with the <tt>--numbered</tt> option. + combined with the <code>--numbered</code> option. </p> </dd> <dt class="hdlist1"> @@ -1310,9 +1484,9 @@ </dt> <dd> <p> - Add a <tt>To:</tt> header to the email headers. This is in addition + Add a <code>To:</code> header to the email headers. This is in addition to any configured headers, and may be used multiple times. - The negated form <tt>--no-to</tt> discards all <tt>To:</tt> headers added so + The negated form <code>--no-to</code> discards all <code>To:</code> headers added so far (from config or command line). </p> </dd> @@ -1321,9 +1495,9 @@ </dt> <dd> <p> - Add a <tt>Cc:</tt> header to the email headers. This is in addition + Add a <code>Cc:</code> header to the email headers. This is in addition to any configured headers, and may be used multiple times. - The negated form <tt>--no-cc</tt> discards all <tt>Cc:</tt> headers added so + The negated form <code>--no-cc</code> discards all <code>Cc:</code> headers added so far (from config or command line). </p> </dd> @@ -1334,9 +1508,9 @@ <p> Add an arbitrary header to the email headers. This is in addition to any configured headers, and may be used multiple times. - For example, <tt>--add-header="Organization: git-foo"</tt>. - The negated form <tt>--no-add-header</tt> discards <strong>all</strong> (<tt>To:</tt>, - <tt>Cc:</tt>, and custom) headers added so far from config or command + For example, <code>--add-header="Organization: git-foo"</code>. + The negated form <code>--no-add-header</code> discards <strong>all</strong> (<code>To:</code>, + <code>Cc:</code>, and custom) headers added so far from config or command line. </p> </dd> @@ -1361,9 +1535,9 @@ <div class="paragraph"><p>The expected use case of this is to write supporting explanation for the commit that does not belong to the commit log message proper, and include it with the patch submission. While one can simply write -these explanations after <tt>format-patch</tt> has run but before sending, +these explanations after <code>format-patch</code> has run but before sending, keeping them as git notes allows them to be maintained between versions -of the patch series (but see the discussion of the <tt>notes.rewrite</tt> +of the patch series (but see the discussion of the <code>notes.rewrite</code> configuration options in <a href="git-notes.html">git-notes(1)</a> to use this workflow).</p></div> </dd> <dt class="hdlist1"> @@ -1382,13 +1556,13 @@ </dt> <dd> <p> - Instead of using <tt>.patch</tt> as the suffix for generated + Instead of using <code>.patch</code> as the suffix for generated filenames, use specified suffix. A common alternative is - <tt>--suffix=.txt</tt>. Leaving this empty will remove the <tt>.patch</tt> + <code>--suffix=.txt</code>. Leaving this empty will remove the <code>.patch</code> suffix. </p> <div class="paragraph"><p>Note that the leading character does not have to be a dot; for example, -you can use <tt>--suffix=-patch</tt> to get <tt>0001-description-of-my-change-patch</tt>.</p></div> +you can use <code>--suffix=-patch</code> to get <code>0001-description-of-my-change-patch</code>.</p></div> </dd> <dt class="hdlist1"> --quiet @@ -1423,6 +1597,8 @@ </dd> </dl></div> </div> +</div> +<div class="sect1"> <h2 id="_configuration">CONFIGURATION</h2> <div class="sectionbody"> <div class="paragraph"><p>You can specify extra mail header lines to be added to each message, @@ -1431,7 +1607,7 @@ attachments, and sign off patches with configuration variables.</p></div> <div class="listingblock"> <div class="content"> -<pre><tt>[format] +<pre><code>[format] headers = "Organization: git-foo\n" subjectprefix = CHANGE suffix = .txt @@ -1439,9 +1615,11 @@ to = <email> cc = <email> attach [ = mime-boundary-string ] - signoff = true</tt></pre> + signoff = true</code></pre> </div></div> </div> +</div> +<div class="sect1"> <h2 id="_discussion">DISCUSSION</h2> <div class="sectionbody"> <div class="paragraph"><p>The patch produced by <em>git format-patch</em> is in UNIX mailbox format, @@ -1449,7 +1627,7 @@ from format-patch rather than a real mailbox, like so:</p></div> <div class="listingblock"> <div class="content"> -<pre><tt>From 8f72bad1baf19a53459661343e21d6491c3908d3 Mon Sep 17 00:00:00 2001 +<pre><code>From 8f72bad1baf19a53459661343e21d6491c3908d3 Mon Sep 17 00:00:00 2001 From: Tony Luck <tony.luck@intel.com> Date: Tue, 13 Jul 2010 11:42:54 -0700 Subject: [PATCH] =?UTF-8?q?[IA64]=20Put=20ia64=20config=20files=20on=20the=20?= @@ -1462,7 +1640,7 @@ (See commit c2330e286f68f1c408b4aa6515ba49d57f05beae comment) Do the same for ia64 so we can have sleek & trim looking -...</tt></pre> +...</code></pre> </div></div> <div class="paragraph"><p>Typically it will be placed in a MUA’s drafts folder, edited to add timely commentary that should not go in the changelog after the three @@ -1473,11 +1651,11 @@ <div class="paragraph"><p>When a patch is part of an ongoing discussion, the patch generated by <em>git format-patch</em> can be tweaked to take advantage of the <em>git am --scissors</em> feature. After your response to the discussion comes a -line that consists solely of "<tt>-- >8 --</tt>" (scissors and perforation), +line that consists solely of "<code>-- >8 --</code>" (scissors and perforation), followed by the patch with unnecessary header fields removed:</p></div> <div class="listingblock"> <div class="content"> -<pre><tt>... +<pre><code>... > So we should do such-and-such. Makes sense to me. How about this patch? @@ -1486,15 +1664,16 @@ Subject: [IA64] Put ia64 config files on the Uwe Kleine-König diet arch/arm config files were slimmed down using a python script -...</tt></pre> +...</code></pre> </div></div> <div class="paragraph"><p>When sending a patch this way, most often you are sending your own -patch, so in addition to the "<tt>From $SHA1 $magic_timestamp</tt>" marker you -should omit <tt>From:</tt> and <tt>Date:</tt> lines from the patch file. The patch +patch, so in addition to the "<code>From $SHA1 $magic_timestamp</code>" marker you +should omit <code>From:</code> and <code>Date:</code> lines from the patch file. The patch title is likely to be different from the subject of the discussion the patch is in response to, so it is likely that you would want to keep the Subject: line, like the example above.</p></div> -<h3 id="_checking_for_patch_corruption">Checking for patch corruption</h3><div style="clear:left"></div> +<div class="sect2"> +<h3 id="_checking_for_patch_corruption">Checking for patch corruption</h3> <div class="paragraph"><p>Many mailers if not set up properly will corrupt whitespace. Here are two common types of corruption:</p></div> <div class="ulist"><ul> @@ -1531,10 +1710,10 @@ </p> <div class="literalblock"> <div class="content"> -<pre><tt>$ git fetch <project> master:test-apply +<pre><code>$ git fetch <project> master:test-apply $ git checkout test-apply $ git reset --hard -$ git am a.patch</tt></pre> +$ git am a.patch</code></pre> </div></div> </li> </ul></div> @@ -1569,11 +1748,15 @@ </li> </ul></div> </div> +</div> +</div> +<div class="sect1"> <h2 id="_mua_specific_hints">MUA-SPECIFIC HINTS</h2> <div class="sectionbody"> <div class="paragraph"><p>Here are some hints on how to successfully submit patches inline using various mailers.</p></div> -<h3 id="_gmail">GMail</h3><div style="clear:left"></div> +<div class="sect2"> +<h3 id="_gmail">GMail</h3> <div class="paragraph"><p>GMail does not have any way to turn off line wrapping in the web interface, so it will mangle any emails that you send. You can however use "git send-email" and send your patches through the GMail SMTP server, or @@ -1583,13 +1766,16 @@ GMail SMTP server, see the EXAMPLE section of <a href="git-send-email.html">git-send-email(1)</a>.</p></div> <div class="paragraph"><p>For hints on submission using the IMAP interface, see the EXAMPLE section of <a href="git-imap-send.html">git-imap-send(1)</a>.</p></div> -<h3 id="_thunderbird">Thunderbird</h3><div style="clear:left"></div> +</div> +<div class="sect2"> +<h3 id="_thunderbird">Thunderbird</h3> <div class="paragraph"><p>By default, Thunderbird will both wrap emails as well as flag them as being <em>format=flowed</em>, both of which will make the resulting email unusable by git.</p></div> <div class="paragraph"><p>There are three different approaches: use an add-on to turn off line wraps, configure Thunderbird to not mangle patches, or use an external editor to keep Thunderbird from mangling the patches.</p></div> +<div class="sect3"> <h4 id="_approach_1_add_on">Approach #1 (add-on)</h4> <div class="paragraph"><p>Install the Toggle Word Wrap add-on that is available from <a href="https://addons.mozilla.org/thunderbird/addon/toggle-word-wrap/">https://addons.mozilla.org/thunderbird/addon/toggle-word-wrap/</a> @@ -1597,6 +1783,8 @@ that you can tick off. Now you can compose the message as you otherwise do (cut + paste, <em>git format-patch</em> | <em>git imap-send</em>, etc), but you have to insert line breaks manually in any text that you type.</p></div> +</div> +<div class="sect3"> <h4 id="_approach_2_configuration">Approach #2 (configuration)</h4> <div class="paragraph"><p>Three steps:</p></div> <div class="olist arabic"><ol class="arabic"> @@ -1616,20 +1804,22 @@ <div class="paragraph"><p>In Thunderbird 3: Edit..Preferences..Advanced..Config Editor. Search for "mail.wrap_long_lines". -Toggle it to make sure it is set to <tt>false</tt>.</p></div> +Toggle it to make sure it is set to <code>false</code>.</p></div> </li> <li> <p> Disable the use of format=flowed: Edit..Preferences..Advanced..Config Editor. Search for "mailnews.send_plaintext_flowed". -Toggle it to make sure it is set to <tt>false</tt>. +Toggle it to make sure it is set to <code>false</code>. </p> </li> </ol></div> <div class="paragraph"><p>After that is done, you should be able to compose email as you otherwise would (cut + paste, <em>git format-patch</em> | <em>git imap-send</em>, etc), and the patches will not be mangled.</p></div> +</div> +<div class="sect3"> <h4 id="_approach_3_external_editor">Approach #3 (external editor)</h4> <div class="paragraph"><p>The following Thunderbird extensions are needed: AboutConfig from <a href="http://aboutconfig.mozdev.org/">http://aboutconfig.mozdev.org/</a> and @@ -1656,8 +1846,8 @@ </p> <div class="listingblock"> <div class="content"> -<pre><tt> mailnews.send_plaintext_flowed => false - mailnews.wraplength => 0</tt></pre> +<pre><code> mailnews.send_plaintext_flowed => false + mailnews.wraplength => 0</code></pre> </div></div> </li> <li> @@ -1676,14 +1866,17 @@ about:config and the following settings but no one’s tried yet.</p></div> <div class="listingblock"> <div class="content"> -<pre><tt> mail.html_compose => false +<pre><code> mail.html_compose => false mail.identity.default.compose_html => false - mail.identity.id?.compose_html => false</tt></pre> + mail.identity.id?.compose_html => false</code></pre> </div></div> <div class="paragraph"><p>There is a script in contrib/thunderbird-patch-inline which can help you include patches with Thunderbird in an easy way. To use it, do the steps above and then use the script as the external editor.</p></div> -<h3 id="_kmail">KMail</h3><div style="clear:left"></div> +</div> +</div> +<div class="sect2"> +<h3 id="_kmail">KMail</h3> <div class="paragraph"><p>This should help you to submit patches inline using KMail.</p></div> <div class="olist arabic"><ol class="arabic"> <li> @@ -1715,6 +1908,9 @@ </li> </ol></div> </div> +</div> +</div> +<div class="sect1"> <h2 id="_examples">EXAMPLES</h2> <div class="sectionbody"> <div class="ulist"><ul> @@ -1725,7 +1921,7 @@ </p> <div class="listingblock"> <div class="content"> -<pre><tt>$ git format-patch -k --stdout R1..R2 | git am -3 -k</tt></pre> +<pre><code>$ git format-patch -k --stdout R1..R2 | git am -3 -k</code></pre> </div></div> </li> <li> @@ -1735,7 +1931,7 @@ </p> <div class="listingblock"> <div class="content"> -<pre><tt>$ git format-patch origin</tt></pre> +<pre><code>$ git format-patch origin</code></pre> </div></div> <div class="paragraph"><p>For each commit a separate file is created in the current directory.</p></div> </li> @@ -1746,7 +1942,7 @@ </p> <div class="listingblock"> <div class="content"> -<pre><tt>$ git format-patch --root origin</tt></pre> +<pre><code>$ git format-patch --root origin</code></pre> </div></div> </li> <li> @@ -1755,7 +1951,7 @@ </p> <div class="listingblock"> <div class="content"> -<pre><tt>$ git format-patch -M -B origin</tt></pre> +<pre><code>$ git format-patch -M -B origin</code></pre> </div></div> <div class="paragraph"><p>Additionally, it detects and handles renames and complete rewrites intelligently to produce a renaming patch. A renaming patch reduces @@ -1770,24 +1966,29 @@ </p> <div class="listingblock"> <div class="content"> -<pre><tt>$ git format-patch -3</tt></pre> +<pre><code>$ git format-patch -3</code></pre> </div></div> </li> </ul></div> </div> +</div> +<div class="sect1"> <h2 id="_see_also">SEE ALSO</h2> <div class="sectionbody"> <div class="paragraph"><p><a href="git-am.html">git-am(1)</a>, <a href="git-send-email.html">git-send-email(1)</a></p></div> </div> +</div> +<div class="sect1"> <h2 id="_git">GIT</h2> <div class="sectionbody"> <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div> </div> </div> +</div> <div id="footnotes"><hr /></div> <div id="footer"> <div id="footer-text"> -Last updated 2012-11-15 13:11:54 PDT +Last updated 2012-11-15 13:11:54 PST </div> </div> </body> diff --git a/git-log.html b/git-log.html index 2b0cec0..17da80a 100644 --- a/git-log.html +++ b/git-log.html
@@ -2,15 +2,25 @@ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> <head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> -<meta name="generator" content="AsciiDoc 8.5.2" /> +<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" /> +<meta name="generator" content="AsciiDoc 8.6.8" /> <title>git-log(1)</title> <style type="text/css"> -/* Debug borders */ -p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 { -/* - border: 1px solid red; -*/ +/* Shared CSS for AsciiDoc xhtml11 and html5 backends */ + +/* Default font. */ +body { + font-family: Georgia,serif; +} + +/* Title font. */ +h1, h2, h3, h4, h5, h6, +div.title, caption.title, +thead, p.table.header, +#toctitle, +#author, #revnumber, #revdate, #revremark, +#footer { + font-family: Arial,Helvetica,sans-serif; } body { @@ -35,13 +45,8 @@ color: #083194; } -tt { - color: navy; -} - h1, h2, h3, h4, h5, h6 { color: #527bbd; - font-family: sans-serif; margin-top: 1.2em; margin-bottom: 0.5em; line-height: 1.3; @@ -59,9 +64,11 @@ h3 + * { clear: left; } +h5 { + font-size: 1.0em; +} div.sectionbody { - font-family: serif; margin-left: 0; } @@ -77,45 +84,48 @@ ul, ol, li > p { margin-top: 0; } +ul > li { color: #aaa; } +ul > li > * { color: black; } -pre { +.monospaced, code, pre { + font-family: "Courier New", Courier, monospace; + font-size: inherit; + color: navy; padding: 0; margin: 0; } -span#author { + +#author { color: #527bbd; - font-family: sans-serif; font-weight: bold; font-size: 1.1em; } -span#email { +#email { } -span#revnumber, span#revdate, span#revremark { - font-family: sans-serif; +#revnumber, #revdate, #revremark { } -div#footer { - font-family: sans-serif; +#footer { font-size: small; border-top: 2px solid silver; padding-top: 0.5em; margin-top: 4.0em; } -div#footer-text { +#footer-text { float: left; padding-bottom: 0.5em; } -div#footer-badges { +#footer-badges { float: right; padding-bottom: 0.5em; } -div#preamble { +#preamble { margin-top: 1.5em; margin-bottom: 1.5em; } -div.tableblock, div.imageblock, div.exampleblock, div.verseblock, +div.imageblock, div.exampleblock, div.verseblock, div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock, div.admonitionblock { margin-top: 1.0em; @@ -135,7 +145,6 @@ /* Block element titles. */ div.title, caption.title { color: #527bbd; - font-family: sans-serif; font-weight: bold; text-align: left; margin-top: 1.0em; @@ -157,13 +166,15 @@ div.sidebarblock > div.content { background: #ffffee; - border: 1px solid silver; + border: 1px solid #dddddd; + border-left: 4px solid #f0f0f0; padding: 0.5em; } div.listingblock > div.content { - border: 1px solid silver; - background: #f4f4f4; + border: 1px solid #dddddd; + border-left: 5px solid #f0f0f0; + background: #f8f8f8; padding: 0.5em; } @@ -171,8 +182,8 @@ padding-left: 1.0em; margin-left: 1.0em; margin-right: 10%; - border-left: 5px solid #dddddd; - color: #777777; + border-left: 5px solid #f0f0f0; + color: #888; } div.quoteblock > div.attribution { @@ -180,8 +191,9 @@ text-align: right; } -div.verseblock > div.content { - white-space: pre; +div.verseblock > pre.content { + font-family: inherit; + font-size: inherit; } div.verseblock > div.attribution { padding-top: 0.75em; @@ -254,35 +266,12 @@ margin-bottom: 0.1em; } -div.tableblock > table { - border: 3px solid #527bbd; -} -thead, p.table.header { - font-family: sans-serif; - font-weight: bold; -} tfoot { font-weight: bold; } td > div.verse { white-space: pre; } -p.table { - margin-top: 0; -} -/* Because the table frame attribute is overriden by CSS in most browsers. */ -div.tableblock > table[frame="void"] { - border-style: none; -} -div.tableblock > table[frame="hsides"] { - border-left-style: none; - border-right-style: none; -} -div.tableblock > table[frame="vsides"] { - border-top-style: none; - border-bottom-style: none; -} - div.hdlist { margin-top: 0.8em; @@ -339,25 +328,32 @@ min-width: 100px; } - -@media print { - div#footer-badges { display: none; } +div.colist td { + padding-right: 0.5em; + padding-bottom: 0.3em; + vertical-align: top; +} +div.colist td img { + margin-top: 0.3em; } -div#toc { +@media print { + #footer-badges { display: none; } +} + +#toc { margin-bottom: 2.5em; } -div#toctitle { +#toctitle { color: #527bbd; - font-family: sans-serif; font-size: 1.1em; font-weight: bold; margin-top: 1.0em; margin-bottom: 0.1em; } -div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 { +div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 { margin-top: 0; margin-bottom: 0; } @@ -373,69 +369,173 @@ margin-left: 6em; font-size: 0.9em; } -/* Overrides for manpage documents */ -h1 { + +span.aqua { color: aqua; } +span.black { color: black; } +span.blue { color: blue; } +span.fuchsia { color: fuchsia; } +span.gray { color: gray; } +span.green { color: green; } +span.lime { color: lime; } +span.maroon { color: maroon; } +span.navy { color: navy; } +span.olive { color: olive; } +span.purple { color: purple; } +span.red { color: red; } +span.silver { color: silver; } +span.teal { color: teal; } +span.white { color: white; } +span.yellow { color: yellow; } + +span.aqua-background { background: aqua; } +span.black-background { background: black; } +span.blue-background { background: blue; } +span.fuchsia-background { background: fuchsia; } +span.gray-background { background: gray; } +span.green-background { background: green; } +span.lime-background { background: lime; } +span.maroon-background { background: maroon; } +span.navy-background { background: navy; } +span.olive-background { background: olive; } +span.purple-background { background: purple; } +span.red-background { background: red; } +span.silver-background { background: silver; } +span.teal-background { background: teal; } +span.white-background { background: white; } +span.yellow-background { background: yellow; } + +span.big { font-size: 2em; } +span.small { font-size: 0.6em; } + +span.underline { text-decoration: underline; } +span.overline { text-decoration: overline; } +span.line-through { text-decoration: line-through; } + +div.unbreakable { page-break-inside: avoid; } + + +/* + * xhtml11 specific + * + * */ + +div.tableblock { + margin-top: 1.0em; + margin-bottom: 1.5em; +} +div.tableblock > table { + border: 3px solid #527bbd; +} +thead, p.table.header { + font-weight: bold; + color: #527bbd; +} +p.table { + margin-top: 0; +} +/* Because the table frame attribute is overriden by CSS in most browsers. */ +div.tableblock > table[frame="void"] { + border-style: none; +} +div.tableblock > table[frame="hsides"] { + border-left-style: none; + border-right-style: none; +} +div.tableblock > table[frame="vsides"] { + border-top-style: none; + border-bottom-style: none; +} + + +/* + * html5 specific + * + * */ + +table.tableblock { + margin-top: 1.0em; + margin-bottom: 1.5em; +} +thead, p.tableblock.header { + font-weight: bold; + color: #527bbd; +} +p.tableblock { + margin-top: 0; +} +table.tableblock { + border-width: 3px; + border-spacing: 0px; + border-style: solid; + border-color: #527bbd; + border-collapse: collapse; +} +th.tableblock, td.tableblock { + border-width: 1px; + padding: 4px; + border-style: solid; + border-color: #527bbd; +} + +table.tableblock.frame-topbot { + border-left-style: hidden; + border-right-style: hidden; +} +table.tableblock.frame-sides { + border-top-style: hidden; + border-bottom-style: hidden; +} +table.tableblock.frame-none { + border-style: hidden; +} + +th.tableblock.halign-left, td.tableblock.halign-left { + text-align: left; +} +th.tableblock.halign-center, td.tableblock.halign-center { + text-align: center; +} +th.tableblock.halign-right, td.tableblock.halign-right { + text-align: right; +} + +th.tableblock.valign-top, td.tableblock.valign-top { + vertical-align: top; +} +th.tableblock.valign-middle, td.tableblock.valign-middle { + vertical-align: middle; +} +th.tableblock.valign-bottom, td.tableblock.valign-bottom { + vertical-align: bottom; +} + + +/* + * manpage specific + * + * */ + +body.manpage h1 { padding-top: 0.5em; padding-bottom: 0.5em; border-top: 2px solid silver; border-bottom: 2px solid silver; } -h2 { +body.manpage h2 { border-style: none; } -div.sectionbody { - margin-left: 5%; +body.manpage div.sectionbody { + margin-left: 3em; } @media print { - div#toc { display: none; } + body.manpage div#toc { display: none; } } -/* Workarounds for IE6's broken and incomplete CSS2. */ -div.sidebar-content { - background: #ffffee; - border: 1px solid silver; - padding: 0.5em; -} -div.sidebar-title, div.image-title { - color: #527bbd; - font-family: sans-serif; - font-weight: bold; - margin-top: 0.0em; - margin-bottom: 0.5em; -} - -div.listingblock div.content { - border: 1px solid silver; - background: #f4f4f4; - padding: 0.5em; -} - -div.quoteblock-attribution { - padding-top: 0.5em; - text-align: right; -} - -div.verseblock-content { - white-space: pre; -} -div.verseblock-attribution { - padding-top: 0.75em; - text-align: left; -} - -div.exampleblock-content { - border-left: 3px solid #dddddd; - padding-left: 0.5em; -} - -/* IE6 sets dynamically generated links as visited. */ -div#toc a:visited { color: blue; } </style> <script type="text/javascript"> /*<+'])'); + var re = new RegExp('[hH]([1-'+(toclevels+1)+'])'); // Function that scans the DOM tree for header elements (the DOM2 // nodeIterator API would be a better technique but not supported by all // browsers). @@ -497,6 +597,25 @@ } var toc = document.getElementById("toc"); + if (!toc) { + return; + } + + // Delete existing TOC entries in case we're reloading the TOC. + var tocEntriesToRemove = []; + var i; + for (i = 0; i < toc.childNodes.length; i++) { + var entry = toc.childNodes[i]; + if (entry.nodeName.toLowerCase() == 'div' + && entry.getAttribute("class") + && entry.getAttribute("class").match(/^toclevel/)) + tocEntriesToRemove.push(entry); + } + for (i = 0; i < tocEntriesToRemove.length; i++) { + toc.removeChild(tocEntriesToRemove[i]); + } + + // Rebuild TOC entries. var entries = tocEntries(document.getElementById("content"), toclevels); for (var i = 0; i < entries.length; ++i) { var entry = entries[i]; @@ -524,24 +643,44 @@ */ footnotes: function () { - var cont = document.getElementById("content"); + // Delete existing footnote entries in case we're reloading the footnodes. + var i; var noteholder = document.getElementById("footnotes"); + if (!noteholder) { + return; + } + var entriesToRemove = []; + for (i = 0; i < noteholder.childNodes.length; i++) { + var entry = noteholder.childNodes[i]; + if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote") + entriesToRemove.push(entry); + } + for (i = 0; i < entriesToRemove.length; i++) { + noteholder.removeChild(entriesToRemove[i]); + } + + // Rebuild footnote entries. + var cont = document.getElementById("content"); var spans = cont.getElementsByTagName("span"); var refs = {}; var n = 0; for (i=0; i<spans.length; i++) { if (spans[i].className == "footnote") { n++; - // Use [\s\S] in place of . so multi-line matches work. - // Because JavaScript has no s (dotall) regex flag. - note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1]; + var note = spans[i].getAttribute("data-note"); + if (!note) { + // Use [\s\S] in place of . so multi-line matches work. + // Because JavaScript has no s (dotall) regex flag. + note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1]; + spans[i].innerHTML = + "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n + + "' title='View footnote' class='footnote'>" + n + "</a>]"; + spans[i].setAttribute("data-note", note); + } noteholder.innerHTML += "<div class='footnote' id='_footnote_" + n + "'>" + "<a href='#_footnoteref_" + n + "' title='Return to text'>" + n + "</a>. " + note + "</div>"; - spans[i].innerHTML = - "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n + - "' title='View footnote' class='footnote'>" + n + "</a>]"; var id =spans[i].getAttribute("id"); if (id != null) refs["#"+id] = n; } @@ -561,13 +700,36 @@ } } } +}, + +install: function(toclevels) { + var timerId; + + function reinstall() { + asciidoc.footnotes(); + if (toclevels) { + asciidoc.toc(toclevels); + } + } + + function reinstallAndRemoveTimer() { + clearInterval(timerId); + reinstall(); + } + + timerId = setInterval(reinstall, 500); + if (document.addEventListener) + document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false); + else + window.onload = reinstallAndRemoveTimer; } } +asciidoc.install(); /*]]>*/ </script> </head> -<body> +<body class="manpage"> <div id="header"> <h1> git-log(1) Manual Page @@ -580,13 +742,16 @@ </div> </div> <div id="content"> +<div class="sect1"> <h2 id="_synopsis">SYNOPSIS</h2> <div class="sectionbody"> <div class="verseblock"> -<div class="verseblock-content"><em>git log</em> [<options>] [<since>..<until>] [[--] <path>…]</div> -<div class="verseblock-attribution"> +<pre class="content"><em>git log</em> [<options>] [<since>..<until>] [[--] <path>…]</pre> +<div class="attribution"> </div></div> </div> +</div> +<div class="sect1"> <h2 id="_description">DESCRIPTION</h2> <div class="sectionbody"> <div class="paragraph"><p>Shows the commit logs.</p></div> @@ -595,6 +760,8 @@ the <em>git diff-*</em> commands to control how the changes each commit introduces are shown.</p></div> </div> +</div> +<div class="sect1"> <h2 id="_options">OPTIONS</h2> <div class="sectionbody"> <div class="dlist"><dl> @@ -605,7 +772,7 @@ <p> Show only commits between the named two commits. When either <since> or <until> is omitted, it defaults to - <tt>HEAD</tt>, i.e. the tip of the current branch. + <code>HEAD</code>, i.e. the tip of the current branch. For a more complete list of ways to spell <since> and <until>, see <a href="gitrevisions.html">gitrevisions(7)</a>. </p> @@ -683,16 +850,19 @@ be prefixed with "-- " to separate them from options or refnames.</p></div> </dd> </dl></div> -<h3 id="_commit_limiting">Commit Limiting</h3><div style="clear:left"></div> +<div class="sect2"> +<h3 id="_commit_limiting">Commit Limiting</h3> <div class="paragraph"><p>Besides specifying a range of commits that should be listed using the special notations explained in the description, additional commit limiting may be applied.</p></div> <div class="paragraph"><p>Using more options generally further limits the output (e.g. -<tt>--since=<date1></tt> limits to commits newer than <tt><date1></tt>, and using it -with <tt>--grep=<pattern></tt> further limits to commits whose log message -has a line that matches <tt><pattern></tt>), unless otherwise noted.</p></div> +<code>--since=<date1></code> limits to commits newer than <code><date1></code>, and using it +with <code>--grep=<pattern></code> further limits to commits whose log message +has a line that matches <code><pattern></code>), unless otherwise noted.</p></div> <div class="paragraph"><p>Note that these are applied before commit -ordering and formatting options, such as <tt>--reverse</tt>.</p></div> +ordering and formatting options, such as <code>--reverse</code>.</p></div> +<div class="openblock"> +<div class="content"> <div class="dlist"><dl> <dt class="hdlist1"> -<number> @@ -748,9 +918,9 @@ <p> Limit the commits output to ones with author/committer header lines that match the specified pattern (regular - expression). With more than one <tt>--author=<pattern></tt>, + expression). With more than one <code>--author=<pattern></code>, commits whose author matches any of the given patterns are - chosen (similarly for multiple <tt>--committer=<pattern></tt>). + chosen (similarly for multiple <code>--committer=<pattern></code>). </p> </dd> <dt class="hdlist1"> @@ -760,9 +930,9 @@ <p> Limit the commits output to ones with reflog entries that match the specified pattern (regular expression). With - more than one <tt>--grep-reflog</tt>, commits whose reflog message + more than one <code>--grep-reflog</code>, commits whose reflog message matches any of the given patterns are chosen. It is an - error to use this option unless <tt>--walk-reflogs</tt> is in use. + error to use this option unless <code>--walk-reflogs</code> is in use. </p> </dd> <dt class="hdlist1"> @@ -772,11 +942,11 @@ <p> Limit the commits output to ones with log message that matches the specified pattern (regular expression). With - more than one <tt>--grep=<pattern></tt>, commits whose message + more than one <code>--grep=<pattern></code>, commits whose message matches any of the given patterns are chosen (but see - <tt>--all-match</tt>). + <code>--all-match</code>). </p> -<div class="paragraph"><p>When <tt>--show-notes</tt> is in effect, the message from the notes as +<div class="paragraph"><p>When <code>--show-notes</code> is in effect, the message from the notes as if it is part of the log message.</p></div> </dd> <dt class="hdlist1"> @@ -854,7 +1024,7 @@ </dt> <dd> <p> - Print only merge commits. This is exactly the same as <tt>--min-parents=2</tt>. + Print only merge commits. This is exactly the same as <code>--min-parents=2</code>. </p> </dd> <dt class="hdlist1"> @@ -863,7 +1033,7 @@ <dd> <p> Do not print commits with more than one parent. This is - exactly the same as <tt>--max-parents=1</tt>. + exactly the same as <code>--max-parents=1</code>. </p> </dd> <dt class="hdlist1"> @@ -881,13 +1051,13 @@ <dd> <p> Show only commits which have at least (or at most) that many - commits. In particular, <tt>--max-parents=1</tt> is the same as <tt>--no-merges</tt>, - <tt>--min-parents=2</tt> is the same as <tt>--merges</tt>. <tt>--max-parents=0</tt> - gives all root commits and <tt>--min-parents=3</tt> all octopus merges. + commits. In particular, <code>--max-parents=1</code> is the same as <code>--no-merges</code>, + <code>--min-parents=2</code> is the same as <code>--merges</code>. <code>--max-parents=0</code> + gives all root commits and <code>--min-parents=3</code> all octopus merges. </p> -<div class="paragraph"><p><tt>--no-min-parents</tt> and <tt>--no-max-parents</tt> reset these limits (to no limit) -again. Equivalent forms are <tt>--min-parents=0</tt> (any commit has 0 or more -parents) and <tt>--max-parents=-1</tt> (negative numbers denote no upper limit).</p></div> +<div class="paragraph"><p><code>--no-min-parents</code> and <code>--no-max-parents</code> reset these limits (to no limit) +again. Equivalent forms are <code>--min-parents=0</code> (any commit has 0 or more +parents) and <code>--max-parents=-1</code> (negative numbers denote no upper limit).</p></div> </dd> <dt class="hdlist1"> --first-parent @@ -917,7 +1087,7 @@ </dt> <dd> <p> - Pretend as if all the refs in <tt>refs/</tt> are listed on the + Pretend as if all the refs in <code>refs/</code> are listed on the command line as <em><commit></em>. </p> </dd> @@ -926,7 +1096,7 @@ </dt> <dd> <p> - Pretend as if all the refs in <tt>refs/heads</tt> are listed + Pretend as if all the refs in <code>refs/heads</code> are listed on the command line as <em><commit></em>. If <em><pattern></em> is given, limit branches to ones matching given shell glob. If pattern lacks <em>?</em>, <em>*</em>, or <em>[</em>, <em>/*</em> at the end is implied. @@ -937,7 +1107,7 @@ </dt> <dd> <p> - Pretend as if all the refs in <tt>refs/tags</tt> are listed + Pretend as if all the refs in <code>refs/tags</code> are listed on the command line as <em><commit></em>. If <em><pattern></em> is given, limit tags to ones matching given shell glob. If pattern lacks <em>?</em>, <em>*</em>, or <em>[</em>, <em>/*</em> at the end is implied. @@ -948,7 +1118,7 @@ </dt> <dd> <p> - Pretend as if all the refs in <tt>refs/remotes</tt> are listed + Pretend as if all the refs in <code>refs/remotes</code> are listed on the command line as <em><commit></em>. If <em><pattern></em> is given, limit remote-tracking branches to ones matching given shell glob. If pattern lacks <em>?</em>, <em>*</em>, or <em>[</em>, <em>/*</em> at the end is implied. @@ -979,9 +1149,9 @@ </dt> <dd> <p> - Pretend as if the bad bisection ref <tt>refs/bisect/bad</tt> - was listed and as if it was followed by <tt>--not</tt> and the good - bisection refs <tt>refs/bisect/good-*</tt> on the command + Pretend as if the bad bisection ref <code>refs/bisect/bad</code> + was listed and as if it was followed by <code>--not</code> and the good + bisection refs <code>refs/bisect/good-*</code> on the command line. </p> </dd> @@ -1001,8 +1171,8 @@ </dt> <dd> <p> - Like <tt>--cherry-pick</tt> (see below) but mark equivalent commits - with <tt>=</tt> rather than omitting them, and inequivalent ones with <tt>+</tt>. + Like <code>--cherry-pick</code> (see below) but mark equivalent commits + with <code>=</code> rather than omitting them, and inequivalent ones with <code>+</code>. </p> </dd> <dt class="hdlist1"> @@ -1014,10 +1184,10 @@ another commit on the "other side" when the set of commits are limited with symmetric difference. </p> -<div class="paragraph"><p>For example, if you have two branches, <tt>A</tt> and <tt>B</tt>, a usual way +<div class="paragraph"><p>For example, if you have two branches, <code>A</code> and <code>B</code>, a usual way to list all commits on only one side of them is with -<tt>--left-right</tt> (see the example below in the description of -the <tt>--left-right</tt> option). It however shows the commits that were cherry-picked +<code>--left-right</code> (see the example below in the description of +the <code>--left-right</code> option). It however shows the commits that were cherry-picked from the other branch (for example, "3rd on b" may be cherry-picked from branch A). With this option, such pairs of commits are excluded from the output.</p></div> @@ -1031,13 +1201,13 @@ <dd> <p> List only commits on the respective side of a symmetric range, - i.e. only those which would be marked <tt><</tt> resp. <tt>></tt> by - <tt>--left-right</tt>. + i.e. only those which would be marked <code><</code> resp. <code>></code> by + <code>--left-right</code>. </p> -<div class="paragraph"><p>For example, <tt>--cherry-pick --right-only A...B</tt> omits those -commits from <tt>B</tt> which are in <tt>A</tt> or are patch-equivalent to a commit in -<tt>A</tt>. In other words, this lists the <tt>+</tt> commits from <tt>git cherry A B</tt>. -More precisely, <tt>--cherry-pick --right-only --no-merges</tt> gives the exact +<div class="paragraph"><p>For example, <code>--cherry-pick --right-only A...B</code> omits those +commits from <code>B</code> which are in <code>A</code> or are patch-equivalent to a commit in +<code>A</code>. In other words, this lists the <code>+</code> commits from <code>git cherry A B</code>. +More precisely, <code>--cherry-pick --right-only --no-merges</code> gives the exact list.</p></div> </dd> <dt class="hdlist1"> @@ -1045,11 +1215,11 @@ </dt> <dd> <p> - A synonym for <tt>--right-only --cherry-mark --no-merges</tt>; useful to + A synonym for <code>--right-only --cherry-mark --no-merges</code>; useful to limit the output to the commits on our side and mark those that have been applied to the other side of a forked history with - <tt>git log --cherry upstream...mybranch</tt>, similar to - <tt>git cherry upstream mybranch</tt>. + <code>git log --cherry upstream...mybranch</code>, similar to + <code>git cherry upstream mybranch</code>. </p> </dd> <dt class="hdlist1"> @@ -1095,7 +1265,10 @@ </p> </dd> </dl></div> -<h3 id="_history_simplification">History Simplification</h3><div style="clear:left"></div> +</div></div> +</div> +<div class="sect2"> +<h3 id="_history_simplification">History Simplification</h3> <div class="paragraph"><p>Sometimes you are only interested in parts of the history, for example the commits modifying a particular <path>. But there are two parts of <em>History Simplification</em>, one part is selecting the commits and the other @@ -1182,57 +1355,57 @@ </dd> </dl></div> <div class="paragraph"><p>A more detailed explanation follows.</p></div> -<div class="paragraph"><p>Suppose you specified <tt>foo</tt> as the <paths>. We shall call commits -that modify <tt>foo</tt> !TREESAME, and the rest TREESAME. (In a diff -filtered for <tt>foo</tt>, they look different and equal, respectively.)</p></div> +<div class="paragraph"><p>Suppose you specified <code>foo</code> as the <paths>. We shall call commits +that modify <code>foo</code> !TREESAME, and the rest TREESAME. (In a diff +filtered for <code>foo</code>, they look different and equal, respectively.)</p></div> <div class="paragraph"><p>In the following, we will always refer to the same example history to illustrate the differences between simplification settings. We assume -that you are filtering for a file <tt>foo</tt> in this commit graph:</p></div> +that you are filtering for a file <code>foo</code> in this commit graph:</p></div> <div class="listingblock"> <div class="content"> -<pre><tt> .-A---M---N---O---P +<pre><code> .-A---M---N---O---P / / / / / I B C D E \ / / / / - `-------------'</tt></pre> + `-------------'</code></pre> </div></div> <div class="paragraph"><p>The horizontal line of history A---P is taken to be the first parent of each merge. The commits are:</p></div> <div class="ulist"><ul> <li> <p> -<tt>I</tt> is the initial commit, in which <tt>foo</tt> exists with contents - "asdf", and a file <tt>quux</tt> exists with contents "quux". Initial - commits are compared to an empty tree, so <tt>I</tt> is !TREESAME. +<code>I</code> is the initial commit, in which <code>foo</code> exists with contents + "asdf", and a file <code>quux</code> exists with contents "quux". Initial + commits are compared to an empty tree, so <code>I</code> is !TREESAME. </p> </li> <li> <p> -In <tt>A</tt>, <tt>foo</tt> contains just "foo". +In <code>A</code>, <code>foo</code> contains just "foo". </p> </li> <li> <p> -<tt>B</tt> contains the same change as <tt>A</tt>. Its merge <tt>M</tt> is trivial and +<code>B</code> contains the same change as <code>A</code>. Its merge <code>M</code> is trivial and hence TREESAME to all parents. </p> </li> <li> <p> -<tt>C</tt> does not change <tt>foo</tt>, but its merge <tt>N</tt> changes it to "foobar", +<code>C</code> does not change <code>foo</code>, but its merge <code>N</code> changes it to "foobar", so it is not TREESAME to any parent. </p> </li> <li> <p> -<tt>D</tt> sets <tt>foo</tt> to "baz". Its merge <tt>O</tt> combines the strings from - <tt>N</tt> and <tt>D</tt> to "foobarbaz"; i.e., it is not TREESAME to any parent. +<code>D</code> sets <code>foo</code> to "baz". Its merge <code>O</code> combines the strings from + <code>N</code> and <code>D</code> to "foobarbaz"; i.e., it is not TREESAME to any parent. </p> </li> <li> <p> -<tt>E</tt> changes <tt>quux</tt> to "xyzzy", and its merge <tt>P</tt> combines the - strings to "quux xyzzy". Despite appearing interesting, <tt>P</tt> is +<code>E</code> changes <code>quux</code> to "xyzzy", and its merge <code>P</code> combines the + strings to "quux xyzzy". Despite appearing interesting, <code>P</code> is TREESAME to all parents. </p> </li> @@ -1257,14 +1430,14 @@ <div class="paragraph"><p>This results in:</p></div> <div class="listingblock"> <div class="content"> -<pre><tt> .-A---N---O +<pre><code> .-A---N---O / / / - I---------D</tt></pre> + I---------D</code></pre> </div></div> <div class="paragraph"><p>Note how the rule to only follow the TREESAME parent, if one is -available, removed <tt>B</tt> from consideration entirely. <tt>C</tt> was -considered via <tt>N</tt>, but is TREESAME. Root commits are compared to an -empty tree, so <tt>I</tt> is !TREESAME.</p></div> +available, removed <code>B</code> from consideration entirely. <code>C</code> was +considered via <code>N</code>, but is TREESAME. Root commits are compared to an +empty tree, so <code>I</code> is !TREESAME.</p></div> <div class="paragraph"><p>Parent/child relations are only visible with --parents, but that does not affect the commits selected in default mode, so we have shown the parent lines.</p></div> @@ -1282,10 +1455,10 @@ </p> <div class="listingblock"> <div class="content"> -<pre><tt> I A B N D O</tt></pre> +<pre><code> I A B N D O</code></pre> </div></div> -<div class="paragraph"><p><tt>P</tt> and <tt>M</tt> were excluded because they are TREESAME to a parent. <tt>E</tt>, -<tt>C</tt> and <tt>B</tt> were all walked, but only <tt>B</tt> was !TREESAME, so the others +<div class="paragraph"><p><code>P</code> and <code>M</code> were excluded because they are TREESAME to a parent. <code>E</code>, +<code>C</code> and <code>B</code> were all walked, but only <code>B</code> was !TREESAME, so the others do not appear.</p></div> <div class="paragraph"><p>Note that without parent rewriting, it is not really possible to talk about the parent/child relationships between the commits, so we show @@ -1304,16 +1477,16 @@ themselves. This results in</p></div> <div class="listingblock"> <div class="content"> -<pre><tt> .-A---M---N---O---P +<pre><code> .-A---M---N---O---P / / / / / I B / D / \ / / / / - `-------------'</tt></pre> + `-------------'</code></pre> </div></div> -<div class="paragraph"><p>Compare to <em>--full-history</em> without rewriting above. Note that <tt>E</tt> +<div class="paragraph"><p>Compare to <em>--full-history</em> without rewriting above. Note that <code>E</code> was pruned away because it is TREESAME, but the parent list of P was -rewritten to contain <tt>E</tt>'s parent <tt>I</tt>. The same happened for <tt>C</tt> and -<tt>N</tt>. Note also that <tt>P</tt> was included despite being TREESAME.</p></div> +rewritten to contain <code>E</code>'s parent <code>I</code>. The same happened for <code>C</code> and +<code>N</code>. Note also that <code>P</code> was included despite being TREESAME.</p></div> </dd> </dl></div> <div class="paragraph"><p>In addition to the above settings, you can change whether TREESAME @@ -1347,54 +1520,60 @@ First, build a history graph in the same way that <em>--full-history</em> with parent rewriting does (see above). </p> -<div class="paragraph"><p>Then simplify each commit <tt>C</tt> to its replacement <tt>C'</tt> in the final +<div class="paragraph"><p>Then simplify each commit <code>C</code> to its replacement <code>C'</code> in the final history according to the following rules:</p></div> +<div class="openblock"> +<div class="content"> <div class="ulist"><ul> <li> <p> -Set <tt>C'</tt> to <tt>C</tt>. +Set <code>C'</code> to <code>C</code>. </p> </li> <li> <p> -Replace each parent <tt>P</tt> of <tt>C'</tt> with its simplification <tt>P'</tt>. In +Replace each parent <code>P</code> of <code>C'</code> with its simplification <code>P'</code>. In the process, drop parents that are ancestors of other parents, and remove duplicates. </p> </li> <li> <p> -If after this parent rewriting, <tt>C'</tt> is a root or merge commit (has +If after this parent rewriting, <code>C'</code> is a root or merge commit (has zero or >1 parents), a boundary commit, or !TREESAME, it remains. Otherwise, it is replaced with its only parent. </p> </li> </ul></div> +</div></div> <div class="paragraph"><p>The effect of this is best shown by way of comparing to <em>--full-history</em> with parent rewriting. The example turns into:</p></div> <div class="listingblock"> <div class="content"> -<pre><tt> .-A---M---N---O +<pre><code> .-A---M---N---O / / / I B D \ / / - `---------'</tt></pre> + `---------'</code></pre> </div></div> -<div class="paragraph"><p>Note the major differences in <tt>N</tt> and <tt>P</tt> over <em>--full-history</em>:</p></div> +<div class="paragraph"><p>Note the major differences in <code>N</code> and <code>P</code> over <em>--full-history</em>:</p></div> +<div class="openblock"> +<div class="content"> <div class="ulist"><ul> <li> <p> -<tt>N</tt>'s parent list had <tt>I</tt> removed, because it is an ancestor of the - other parent <tt>M</tt>. Still, <tt>N</tt> remained because it is !TREESAME. +<code>N</code>'s parent list had <code>I</code> removed, because it is an ancestor of the + other parent <code>M</code>. Still, <code>N</code> remained because it is !TREESAME. </p> </li> <li> <p> -<tt>P</tt>'s parent list similarly had <tt>I</tt> removed. <tt>P</tt> was then +<code>P</code>'s parent list similarly had <code>I</code> removed. <code>P</code> was then removed completely, because it had one parent and is TREESAME. </p> </li> </ul></div> +</div></div> </dd> </dl></div> <div class="paragraph"><p>Finally, there is a fifth simplification mode available:</p></div> @@ -1412,30 +1591,30 @@ <div class="paragraph"><p>As an example use case, consider the following commit history:</p></div> <div class="listingblock"> <div class="content"> -<pre><tt> D---E-------F +<pre><code> D---E-------F / \ \ B---C---G---H---I---J / \ - A-------K---------------L--M</tt></pre> + A-------K---------------L--M</code></pre> </div></div> -<div class="paragraph"><p>A regular <em>D..M</em> computes the set of commits that are ancestors of <tt>M</tt>, -but excludes the ones that are ancestors of <tt>D</tt>. This is useful to see -what happened to the history leading to <tt>M</tt> since <tt>D</tt>, in the sense -that "what does <tt>M</tt> have that did not exist in <tt>D</tt>". The result in this -example would be all the commits, except <tt>A</tt> and <tt>B</tt> (and <tt>D</tt> itself, +<div class="paragraph"><p>A regular <em>D..M</em> computes the set of commits that are ancestors of <code>M</code>, +but excludes the ones that are ancestors of <code>D</code>. This is useful to see +what happened to the history leading to <code>M</code> since <code>D</code>, in the sense +that "what does <code>M</code> have that did not exist in <code>D</code>". The result in this +example would be all the commits, except <code>A</code> and <code>B</code> (and <code>D</code> itself, of course).</p></div> -<div class="paragraph"><p>When we want to find out what commits in <tt>M</tt> are contaminated with the -bug introduced by <tt>D</tt> and need fixing, however, we might want to view -only the subset of <em>D..M</em> that are actually descendants of <tt>D</tt>, i.e. -excluding <tt>C</tt> and <tt>K</tt>. This is exactly what the <em>--ancestry-path</em> +<div class="paragraph"><p>When we want to find out what commits in <code>M</code> are contaminated with the +bug introduced by <code>D</code> and need fixing, however, we might want to view +only the subset of <em>D..M</em> that are actually descendants of <code>D</code>, i.e. +excluding <code>C</code> and <code>K</code>. This is exactly what the <em>--ancestry-path</em> option does. Applied to the <em>D..M</em> range, it results in:</p></div> <div class="listingblock"> <div class="content"> -<pre><tt> E-------F +<pre><code> E-------F \ \ G---H---I---J \ - L--M</tt></pre> + L--M</code></pre> </div></div> </dd> </dl></div> @@ -1446,7 +1625,9 @@ above) if (1) they are referenced by tags, or (2) they change the contents of the paths given on the command line. All other commits are marked as TREESAME (subject to be simplified away).</p></div> -<h3 id="_commit_ordering">Commit Ordering</h3><div style="clear:left"></div> +</div> +<div class="sect2"> +<h3 id="_commit_ordering">Commit Ordering</h3> <div class="paragraph"><p>By default, the commits are shown in reverse chronological order.</p></div> <div class="dlist"><dl> <dt class="hdlist1"> @@ -1470,14 +1651,14 @@ <div class="paragraph"><p>For example, in a commit history like this:</p></div> <div class="listingblock"> <div class="content"> -<pre><tt> ---1----2----4----7 +<pre><code> ---1----2----4----7 \ \ - 3----5----6----8---</tt></pre> + 3----5----6----8---</code></pre> </div></div> -<div class="paragraph"><p>where the numbers denote the order of commit timestamps, <tt>git -rev-list</tt> and friends with <tt>--date-order</tt> show the commits in the +<div class="paragraph"><p>where the numbers denote the order of commit timestamps, <code>git +rev-list</code> and friends with <code>--date-order</code> show the commits in the timestamp order: 8 7 6 5 4 3 2 1.</p></div> -<div class="paragraph"><p>With <tt>--topo-order</tt>, they would show 8 6 5 3 7 4 2 1 (or 8 7 4 2 6 5 +<div class="paragraph"><p>With <code>--topo-order</code>, they would show 8 6 5 3 7 4 2 1 (or 8 7 4 2 6 5 3 1); some older commits are shown before newer ones in order to avoid showing the commits from two parallel development track mixed together.</p></div> @@ -1492,7 +1673,9 @@ </p> </dd> </dl></div> -<h3 id="_object_traversal">Object Traversal</h3><div style="clear:left"></div> +</div> +<div class="sect2"> +<h3 id="_object_traversal">Object Traversal</h3> <div class="paragraph"><p>These options are mostly targeted for packing of git repositories.</p></div> <div class="dlist"><dl> <dt class="hdlist1"> @@ -1549,7 +1732,9 @@ </p> </dd> </dl></div> -<h3 id="_commit_formatting">Commit Formatting</h3><div style="clear:left"></div> +</div> +<div class="sect2"> +<h3 id="_commit_formatting">Commit Formatting</h3> <div class="dlist"><dl> <dt class="hdlist1"> --pretty[=<format>] @@ -1587,7 +1772,7 @@ <dd> <p> Show the full 40-byte hexadecimal commit object name. This negates - <tt>--abbrev-commit</tt> and those options which imply it such as + <code>--abbrev-commit</code> and those options which imply it such as "--oneline". It also overrides the <em>log.abbrevCommit</em> variable. </p> </dd> @@ -1619,15 +1804,15 @@ <p> Show the notes (see <a href="git-notes.html">git-notes(1)</a>) that annotate the commit, when showing the commit log message. This is the default - for <tt>git log</tt>, <tt>git show</tt> and <tt>git whatchanged</tt> commands when - there is no <tt>--pretty</tt>, <tt>--format</tt> nor <tt>--oneline</tt> option given + for <code>git log</code>, <code>git show</code> and <code>git whatchanged</code> commands when + there is no <code>--pretty</code>, <code>--format</code> nor <code>--oneline</code> option given on the command line. </p> <div class="paragraph"><p>By default, the notes shown are from the notes refs listed in the <em>core.notesRef</em> and <em>notes.displayRef</em> variables (or corresponding environment overrides). See <a href="git-config.html">git-config(1)</a> for more details.</p></div> <div class="paragraph"><p>With an optional <em><ref></em> argument, show this notes ref instead of the -default notes ref(s). The ref is taken to be in <tt>refs/notes/</tt> if it +default notes ref(s). The ref is taken to be in <code>refs/notes/</code> if it is not qualified.</p></div> <div class="paragraph"><p>Multiple --notes options can be combined to control which notes are being displayed. Examples: "--notes=foo" will show only notes from @@ -1639,7 +1824,7 @@ </dt> <dd> <p> - Do not show notes. This negates the above <tt>--notes</tt> option, by + Do not show notes. This negates the above <code>--notes</code> option, by resetting the list of notes refs from which notes are shown. Options are parsed in the order given on the command line, so e.g. "--notes --notes=foo --no-notes --notes=bar" will only show notes @@ -1664,7 +1849,7 @@ <dd> <p> Check the validity of a signed commit object by passing the signature - to <tt>gpg --verify</tt> and show the output. + to <code>gpg --verify</code> and show the output. </p> </dd> <dt class="hdlist1"> @@ -1672,7 +1857,7 @@ </dt> <dd> <p> - Synonym for <tt>--date=relative</tt>. + Synonym for <code>--date=relative</code>. </p> </dd> <dt class="hdlist1"> @@ -1681,18 +1866,18 @@ <dd> <p> Only takes effect for dates shown in human-readable format, such - as when using "--pretty". <tt>log.date</tt> config variable sets a default + as when using "--pretty". <code>log.date</code> config variable sets a default value for log command’s --date option. </p> -<div class="paragraph"><p><tt>--date=relative</tt> shows dates relative to the current time, +<div class="paragraph"><p><code>--date=relative</code> shows dates relative to the current time, e.g. "2 hours ago".</p></div> -<div class="paragraph"><p><tt>--date=local</tt> shows timestamps in user’s local timezone.</p></div> -<div class="paragraph"><p><tt>--date=iso</tt> (or <tt>--date=iso8601</tt>) shows timestamps in ISO 8601 format.</p></div> -<div class="paragraph"><p><tt>--date=rfc</tt> (or <tt>--date=rfc2822</tt>) shows timestamps in RFC 2822 +<div class="paragraph"><p><code>--date=local</code> shows timestamps in user’s local timezone.</p></div> +<div class="paragraph"><p><code>--date=iso</code> (or <code>--date=iso8601</code>) shows timestamps in ISO 8601 format.</p></div> +<div class="paragraph"><p><code>--date=rfc</code> (or <code>--date=rfc2822</code>) shows timestamps in RFC 2822 format, often found in E-mail messages.</p></div> -<div class="paragraph"><p><tt>--date=short</tt> shows only date but not time, in <tt>YYYY-MM-DD</tt> format.</p></div> -<div class="paragraph"><p><tt>--date=raw</tt> shows the date in the internal raw git format <tt>%s %z</tt> format.</p></div> -<div class="paragraph"><p><tt>--date=default</tt> shows timestamps in the original timezone +<div class="paragraph"><p><code>--date=short</code> shows only date but not time, in <code>YYYY-MM-DD</code> format.</p></div> +<div class="paragraph"><p><code>--date=raw</code> shows the date in the internal raw git format <code>%s %z</code> format.</p></div> +<div class="paragraph"><p><code>--date=default</code> shows timestamps in the original timezone (either committer’s or author’s).</p></div> </dd> <dt class="hdlist1"> @@ -1719,30 +1904,30 @@ <dd> <p> Mark which side of a symmetric diff a commit is reachable from. - Commits from the left side are prefixed with <tt><</tt> and those from - the right with <tt>></tt>. If combined with <tt>--boundary</tt>, those - commits are prefixed with <tt>-</tt>. + Commits from the left side are prefixed with <code><</code> and those from + the right with <code>></code>. If combined with <code>--boundary</code>, those + commits are prefixed with <code>-</code>. </p> <div class="paragraph"><p>For example, if you have this topology:</p></div> <div class="listingblock"> <div class="content"> -<pre><tt> y---b---b branch B +<pre><code> y---b---b branch B / \ / / . / / \ - o---x---a---a branch A</tt></pre> + o---x---a---a branch A</code></pre> </div></div> <div class="paragraph"><p>you would get an output like this:</p></div> <div class="listingblock"> <div class="content"> -<pre><tt> $ git rev-list --left-right --boundary --pretty=oneline A...B +<pre><code> $ git rev-list --left-right --boundary --pretty=oneline A...B >bbbbbbb... 3rd on b >bbbbbbb... 2nd on b <aaaaaaa... 3rd on a <aaaaaaa... 2nd on a -yyyyyyy... 1st on b - -xxxxxxx... 1st on a</tt></pre> + -xxxxxxx... 1st on a</code></pre> </div></div> </dd> <dt class="hdlist1"> @@ -1760,7 +1945,9 @@ <em>--date-order</em> option may also be specified.</p></div> </dd> </dl></div> -<h3 id="_diff_formatting">Diff Formatting</h3><div style="clear:left"></div> +</div> +<div class="sect2"> +<h3 id="_diff_formatting">Diff Formatting</h3> <div class="paragraph"><p>Below are listed options that control the formatting of diff output. Some of them are specific to <a href="git-rev-list.html">git-rev-list(1)</a>, however other diff options may be given. See <a href="git-diff-files.html">git-diff-files(1)</a> for more options.</p></div> @@ -1827,6 +2014,9 @@ </dd> </dl></div> </div> +</div> +</div> +<div class="sect1"> <h2 id="_pretty_formats">PRETTY FORMATS</h2> <div class="sectionbody"> <div class="paragraph"><p>If the commit is a merge, and if the pretty-format @@ -1851,7 +2041,7 @@ </p> <div class="literalblock"> <div class="content"> -<pre><tt><sha1> <title line></tt></pre> +<pre><code><sha1> <title line></code></pre> </div></div> <div class="paragraph"><p>This is designed to be as compact as possible.</p></div> </li> @@ -1861,12 +2051,12 @@ </p> <div class="literalblock"> <div class="content"> -<pre><tt>commit <sha1> -Author: <author></tt></pre> +<pre><code>commit <sha1> +Author: <author></code></pre> </div></div> <div class="literalblock"> <div class="content"> -<pre><tt><title line></tt></pre> +<pre><code><title line></code></pre> </div></div> </li> <li> @@ -1875,17 +2065,17 @@ </p> <div class="literalblock"> <div class="content"> -<pre><tt>commit <sha1> +<pre><code>commit <sha1> Author: <author> -Date: <author date></tt></pre> +Date: <author date></code></pre> </div></div> <div class="literalblock"> <div class="content"> -<pre><tt><title line></tt></pre> +<pre><code><title line></code></pre> </div></div> <div class="literalblock"> <div class="content"> -<pre><tt><full commit message></tt></pre> +<pre><code><full commit message></code></pre> </div></div> </li> <li> @@ -1894,17 +2084,17 @@ </p> <div class="literalblock"> <div class="content"> -<pre><tt>commit <sha1> +<pre><code>commit <sha1> Author: <author> -Commit: <committer></tt></pre> +Commit: <committer></code></pre> </div></div> <div class="literalblock"> <div class="content"> -<pre><tt><title line></tt></pre> +<pre><code><title line></code></pre> </div></div> <div class="literalblock"> <div class="content"> -<pre><tt><full commit message></tt></pre> +<pre><code><full commit message></code></pre> </div></div> </li> <li> @@ -1913,19 +2103,19 @@ </p> <div class="literalblock"> <div class="content"> -<pre><tt>commit <sha1> +<pre><code>commit <sha1> Author: <author> AuthorDate: <author date> Commit: <committer> -CommitDate: <committer date></tt></pre> +CommitDate: <committer date></code></pre> </div></div> <div class="literalblock"> <div class="content"> -<pre><tt><title line></tt></pre> +<pre><code><title line></code></pre> </div></div> <div class="literalblock"> <div class="content"> -<pre><tt><full commit message></tt></pre> +<pre><code><full commit message></code></pre> </div></div> </li> <li> @@ -1934,14 +2124,14 @@ </p> <div class="literalblock"> <div class="content"> -<pre><tt>From <sha1> <date> +<pre><code>From <sha1> <date> From: <author> Date: <author date> -Subject: [PATCH] <title line></tt></pre> +Subject: [PATCH] <title line></code></pre> </div></div> <div class="literalblock"> <div class="content"> -<pre><tt><full commit message></tt></pre> +<pre><code><full commit message></code></pre> </div></div> </li> <li> @@ -1967,8 +2157,8 @@ would show something like this:</p></div> <div class="listingblock"> <div class="content"> -<pre><tt>The author of fe6e0ee was Junio C Hamano, 23 hours ago -The title was >>t4119: test autocomputing -p<n> for traditional diff input.<<</tt></pre> +<pre><code>The author of fe6e0ee was Junio C Hamano, 23 hours ago +The title was >>t4119: test autocomputing -p<n> for traditional diff input.<<</code></pre> </div></div> <div class="paragraph"><p>The placeholders are:</p></div> <div class="ulist"><ul> @@ -2144,12 +2334,12 @@ </li> <li> <p> -<em>%gD</em>: reflog selector, e.g., <tt>refs/stash@{1}</tt> +<em>%gD</em>: reflog selector, e.g., <code>refs/stash@{1}</code> </p> </li> <li> <p> -<em>%gd</em>: shortened reflog selector, e.g., <tt>stash@{1}</tt> +<em>%gd</em>: shortened reflog selector, e.g., <code>stash@{1}</code> </p> </li> <li> @@ -2237,16 +2427,16 @@ <div class="title">Note</div> </td> <td class="content">Some placeholders may depend on other options given to the -revision traversal engine. For example, the <tt>%g*</tt> reflog options will +revision traversal engine. For example, the <code>%g*</code> reflog options will insert an empty string unless we are traversing reflog entries (e.g., by -<tt>git log -g</tt>). The <tt>%d</tt> placeholder will use the "short" decoration -format if <tt>--decorate</tt> was not already provided on the command line.</td> +<code>git log -g</code>). The <code>%d</code> placeholder will use the "short" decoration +format if <code>--decorate</code> was not already provided on the command line.</td> </tr></table> </div> -<div class="paragraph"><p>If you add a <tt>+</tt> (plus sign) after <em>%</em> of a placeholder, a line-feed +<div class="paragraph"><p>If you add a <code>+</code> (plus sign) after <em>%</em> of a placeholder, a line-feed is inserted immediately before the expansion if and only if the placeholder expands to a non-empty string.</p></div> -<div class="paragraph"><p>If you add a <tt>-</tt> (minus sign) after <em>%</em> of a placeholder, line-feeds that +<div class="paragraph"><p>If you add a <code>-</code> (minus sign) after <em>%</em> of a placeholder, line-feeds that immediately precede the expansion are deleted if and only if the placeholder expands to an empty string.</p></div> <div class="paragraph"><p>If you add a ` ` (space) after <em>%</em> of a placeholder, a space @@ -2266,7 +2456,7 @@ For example:</p></div> <div class="listingblock"> <div class="content"> -<pre><tt>$ git log -2 --pretty=format:%h 4da45bef \ +<pre><code>$ git log -2 --pretty=format:%h 4da45bef \ | perl -pe '$_ .= " -- NO NEWLINE\n" unless /\n/' 4da45be 7134973 -- NO NEWLINE @@ -2274,19 +2464,21 @@ $ git log -2 --pretty=tformat:%h 4da45bef \ | perl -pe '$_ .= " -- NO NEWLINE\n" unless /\n/' 4da45be -7134973</tt></pre> +7134973</code></pre> </div></div> -<div class="paragraph"><p>In addition, any unrecognized string that has a <tt>%</tt> in it is interpreted -as if it has <tt>tformat:</tt> in front of it. For example, these two are +<div class="paragraph"><p>In addition, any unrecognized string that has a <code>%</code> in it is interpreted +as if it has <code>tformat:</code> in front of it. For example, these two are equivalent:</p></div> <div class="listingblock"> <div class="content"> -<pre><tt>$ git log -2 --pretty=tformat:%h 4da45bef -$ git log -2 --pretty=%h 4da45bef</tt></pre> +<pre><code>$ git log -2 --pretty=tformat:%h 4da45bef +$ git log -2 --pretty=%h 4da45bef</code></pre> </div></div> </li> </ul></div> </div> +</div> +<div class="sect1"> <h2 id="_common_diff_options">Common diff options</h2> <div class="sectionbody"> <div class="dlist"><dl> @@ -2315,7 +2507,7 @@ <p> Generate diffs with <n> lines of context instead of the usual three. - Implies <tt>-p</tt>. + Implies <code>-p</code>. </p> </dd> <dt class="hdlist1"> @@ -2332,7 +2524,7 @@ </dt> <dd> <p> - Synonym for <tt>-p --raw</tt>. + Synonym for <code>-p --raw</code>. </p> </dd> <dt class="hdlist1"> @@ -2369,29 +2561,29 @@ will be used for the filename part, and the rest for the graph part. Maximum width defaults to terminal width, or 80 columns if not connected to a terminal, and can be overridden by - <tt><width></tt>. The width of the filename part can be limited by - giving another width <tt><name-width></tt> after a comma. The width + <code><width></code>. The width of the filename part can be limited by + giving another width <code><name-width></code> after a comma. The width of the graph part can be limited by using - <tt>--stat-graph-width=<width></tt> (affects all commands generating - a stat graph) or by setting <tt>diff.statGraphWidth=<width></tt> - (does not affect <tt>git format-patch</tt>). - By giving a third parameter <tt><count></tt>, you can limit the - output to the first <tt><count></tt> lines, followed by <tt>...</tt> if + <code>--stat-graph-width=<width></code> (affects all commands generating + a stat graph) or by setting <code>diff.statGraphWidth=<width></code> + (does not affect <code>git format-patch</code>). + By giving a third parameter <code><count></code>, you can limit the + output to the first <code><count></code> lines, followed by <code>...</code> if there are more. </p> -<div class="paragraph"><p>These parameters can also be set individually with <tt>--stat-width=<width></tt>, -<tt>--stat-name-width=<name-width></tt> and <tt>--stat-count=<count></tt>.</p></div> +<div class="paragraph"><p>These parameters can also be set individually with <code>--stat-width=<width></code>, +<code>--stat-name-width=<name-width></code> and <code>--stat-count=<count></code>.</p></div> </dd> <dt class="hdlist1"> --numstat </dt> <dd> <p> - Similar to <tt>--stat</tt>, but shows number of added and + Similar to <code>--stat</code>, but shows number of added and deleted lines in decimal notation and pathname without abbreviation, to make it more machine friendly. For - binary files, outputs two <tt>-</tt> instead of saying - <tt>0 0</tt>. + binary files, outputs two <code>-</code> instead of saying + <code>0 0</code>. </p> </dd> <dt class="hdlist1"> @@ -2399,7 +2591,7 @@ </dt> <dd> <p> - Output only the last line of the <tt>--stat</tt> format containing total + Output only the last line of the <code>--stat</code> format containing total number of modified files, as well as number of added and deleted lines. </p> @@ -2410,15 +2602,17 @@ <dd> <p> Output the distribution of relative amount of changes for each - sub-directory. The behavior of <tt>--dirstat</tt> can be customized by + sub-directory. The behavior of <code>--dirstat</code> can be customized by passing it a comma separated list of parameters. - The defaults are controlled by the <tt>diff.dirstat</tt> configuration + The defaults are controlled by the <code>diff.dirstat</code> configuration variable (see <a href="git-config.html">git-config(1)</a>). The following parameters are available: </p> +<div class="openblock"> +<div class="content"> <div class="dlist"><dl> <dt class="hdlist1"> -<tt>changes</tt> +<code>changes</code> </dt> <dd> <p> @@ -2430,39 +2624,39 @@ </p> </dd> <dt class="hdlist1"> -<tt>lines</tt> +<code>lines</code> </dt> <dd> <p> Compute the dirstat numbers by doing the regular line-based diff analysis, and summing the removed/added line counts. (For binary files, count 64-byte chunks instead, since binary files have no - natural concept of lines). This is a more expensive <tt>--dirstat</tt> - behavior than the <tt>changes</tt> behavior, but it does count rearranged + natural concept of lines). This is a more expensive <code>--dirstat</code> + behavior than the <code>changes</code> behavior, but it does count rearranged lines within a file as much as other changes. The resulting output - is consistent with what you get from the other <tt>--*stat</tt> options. + is consistent with what you get from the other <code>--*stat</code> options. </p> </dd> <dt class="hdlist1"> -<tt>files</tt> +<code>files</code> </dt> <dd> <p> Compute the dirstat numbers by counting the number of files changed. Each changed file counts equally in the dirstat analysis. This is - the computationally cheapest <tt>--dirstat</tt> behavior, since it does + the computationally cheapest <code>--dirstat</code> behavior, since it does not have to look at the file contents at all. </p> </dd> <dt class="hdlist1"> -<tt>cumulative</tt> +<code>cumulative</code> </dt> <dd> <p> Count changes in a child directory for the parent directory as well. - Note that when using <tt>cumulative</tt>, the sum of the percentages + Note that when using <code>cumulative</code>, the sum of the percentages reported may exceed 100%. The default (non-cumulative) behavior can - be specified with the <tt>noncumulative</tt> parameter. + be specified with the <code>noncumulative</code> parameter. </p> </dd> <dt class="hdlist1"> @@ -2476,10 +2670,11 @@ </p> </dd> </dl></div> +</div></div> <div class="paragraph"><p>Example: The following will count changed files, while ignoring directories with less than 10% of the total amount of changed files, and accumulating child directory counts in the parent directories: -<tt>--dirstat=files,10,cumulative</tt>.</p></div> +<code>--dirstat=files,10,cumulative</code>.</p></div> </dd> <dt class="hdlist1"> --summary @@ -2495,7 +2690,7 @@ </dt> <dd> <p> - Synonym for <tt>-p --stat</tt>. + Synonym for <code>-p --stat</code>. </p> </dd> <dt class="hdlist1"> @@ -2505,10 +2700,10 @@ <p> Separate the commits with NULs instead of with new newlines. </p> -<div class="paragraph"><p>Also, when <tt>--raw</tt> or <tt>--numstat</tt> has been given, do not munge +<div class="paragraph"><p>Also, when <code>--raw</code> or <code>--numstat</code> has been given, do not munge pathnames and use NULs as output field terminators.</p></div> <div class="paragraph"><p>Without this option, each pathname output will have TAB, LF, double quotes, -and backslash characters replaced with <tt>\t</tt>, <tt>\n</tt>, <tt>\"</tt>, and <tt>\\</tt>, +and backslash characters replaced with <code>\t</code>, <code>\n</code>, <code>\"</code>, and <code>\\</code>, respectively, and the pathname will be enclosed in double quotes if any of those replacements occurred.</p></div> </dd> @@ -2526,7 +2721,7 @@ <dd> <p> Show only names and status of changed files. See the description - of the <tt>--diff-filter</tt> option on what the status letters mean. + of the <code>--diff-filter</code> option on what the status letters mean. </p> </dd> <dt class="hdlist1"> @@ -2534,13 +2729,13 @@ </dt> <dd> <p> - Specify how differences in submodules are shown. When <tt>--submodule</tt> - or <tt>--submodule=log</tt> is given, the <em>log</em> format is used. This format lists - the commits in the range like <a href="git-submodule.html">git-submodule(1)</a> <tt>summary</tt> does. - Omitting the <tt>--submodule</tt> option or specifying <tt>--submodule=short</tt>, + Specify how differences in submodules are shown. When <code>--submodule</code> + or <code>--submodule=log</code> is given, the <em>log</em> format is used. This format lists + the commits in the range like <a href="git-submodule.html">git-submodule(1)</a> <code>summary</code> does. + Omitting the <code>--submodule</code> option or specifying <code>--submodule=short</code>, uses the <em>short</em> format. This format just shows the names of the commits at the beginning and end of the range. Can be tweaked via the - <tt>diff.submodule</tt> configuration variable. + <code>diff.submodule</code> configuration variable. </p> </dd> <dt class="hdlist1"> @@ -2549,8 +2744,8 @@ <dd> <p> Show colored diff. - The value must be <tt>always</tt> (the default for <tt><when></tt>), <tt>never</tt>, or <tt>auto</tt>. - The default value is <tt>never</tt>. + The value must be <code>always</code> (the default for <code><when></code>), <code>never</code>, or <code>auto</code>. + The default value is <code>never</code>. </p> </dd> <dt class="hdlist1"> @@ -2559,7 +2754,7 @@ <dd> <p> Turn off colored diff. - It is the same as <tt>--color=never</tt>. + It is the same as <code>--color=never</code>. </p> </dd> <dt class="hdlist1"> @@ -2569,16 +2764,18 @@ <p> Show a word diff, using the <mode> to delimit changed words. By default, words are delimited by whitespace; see - <tt>--word-diff-regex</tt> below. The <mode> defaults to <em>plain</em>, and + <code>--word-diff-regex</code> below. The <mode> defaults to <em>plain</em>, and must be one of: </p> +<div class="openblock"> +<div class="content"> <div class="dlist"><dl> <dt class="hdlist1"> color </dt> <dd> <p> - Highlight changed words using only colors. Implies <tt>--color</tt>. + Highlight changed words using only colors. Implies <code>--color</code>. </p> </dd> <dt class="hdlist1"> @@ -2586,7 +2783,7 @@ </dt> <dd> <p> - Show words as <tt>[-removed-]</tt> and <tt>{+added+}</tt>. Makes no + Show words as <code>[-removed-]</code> and <code>{+added+}</code>. Makes no attempts to escape the delimiters if they appear in the input, so the output may be ambiguous. </p> @@ -2598,10 +2795,10 @@ <p> Use a special line-based format intended for script consumption. Added/removed/unchanged runs are printed in the - usual unified diff format, starting with a <tt>+</tt>/<tt>-</tt>/` ` + usual unified diff format, starting with a <code>+</code>/<code>-</code>/` ` character at the beginning of the line and extending to the end of the line. Newlines in the input are represented by a - tilde <tt>~</tt> on a line of its own. + tilde <code>~</code> on a line of its own. </p> </dd> <dt class="hdlist1"> @@ -2613,6 +2810,7 @@ </p> </dd> </dl></div> +</div></div> <div class="paragraph"><p>Note that despite the name of the first mode, color is used to highlight the changed parts in all modes if enabled.</p></div> </dd> @@ -2623,12 +2821,12 @@ <p> Use <regex> to decide what a word is, instead of considering runs of non-whitespace to be a word. Also implies - <tt>--word-diff</tt> unless it was already enabled. + <code>--word-diff</code> unless it was already enabled. </p> <div class="paragraph"><p>Every non-overlapping match of the <regex> is considered a word. Anything between these matches is considered whitespace and ignored(!) for the purposes of finding -differences. You may want to append <tt>|[^[:space:]]</tt> to your regular +differences. You may want to append <code>|[^[:space:]]</code> to your regular expression to make sure that it matches all non-whitespace characters. A match that contains a newline is silently truncated(!) at the newline.</p></div> @@ -2642,8 +2840,8 @@ </dt> <dd> <p> - Equivalent to <tt>--word-diff=color</tt> plus (if a regex was - specified) <tt>--word-diff-regex=<regex></tt>. + Equivalent to <code>--word-diff=color</code> plus (if a regex was + specified) <code>--word-diff-regex=<regex></code>. </p> </dd> <dt class="hdlist1"> @@ -2661,7 +2859,7 @@ <dd> <p> Warn if changes introduce whitespace errors. What are - considered whitespace errors is controlled by <tt>core.whitespace</tt> + considered whitespace errors is controlled by <code>core.whitespace</code> configuration. By default, trailing whitespaces (including lines that solely consist of whitespaces) and a space character that is immediately followed by a tab character inside the @@ -2685,8 +2883,8 @@ </dt> <dd> <p> - In addition to <tt>--full-index</tt>, output a binary diff that - can be applied with <tt>git-apply</tt>. + In addition to <code>--full-index</code>, output a binary diff that + can be applied with <code>git-apply</code>. </p> </dd> <dt class="hdlist1"> @@ -2697,9 +2895,9 @@ Instead of showing the full 40-byte hexadecimal object name in diff-raw format output and diff-tree header lines, show only a partial prefix. This is - independent of the <tt>--full-index</tt> option above, which controls + independent of the <code>--full-index</code> option above, which controls the diff-patch output format. Non default number of - digits can be specified with <tt>--abbrev=<n></tt>. + digits can be specified with <code>--abbrev=<n></code>. </p> </dd> <dt class="hdlist1"> @@ -2717,15 +2915,15 @@ not as a series of deletion and insertion mixed together with a very few lines that happen to match textually as the context, but as a single deletion of everything old followed by a single insertion of -everything new, and the number <tt>m</tt> controls this aspect of the -B -option (defaults to 60%). <tt>-B/70%</tt> specifies that less than 30% of the +everything new, and the number <code>m</code> controls this aspect of the -B +option (defaults to 60%). <code>-B/70%</code> specifies that less than 30% of the original should remain in the result for git to consider it a total rewrite (i.e. otherwise the resulting patch will be a series of deletion and insertion mixed together with context lines).</p></div> <div class="paragraph"><p>When used with -M, a totally-rewritten file is also considered as the source of a rename (usually -M only considers a file that disappeared -as the source of a rename), and the number <tt>n</tt> controls this aspect of -the -B option (defaults to 50%). <tt>-B20%</tt> specifies that a change with +as the source of a rename), and the number <code>n</code> controls this aspect of +the -B option (defaults to 50%). <code>-B20%</code> specifies that a change with addition and deletion compared to 20% or more of the file’s size are eligible for being picked up as a possible source of a rename to another file.</p></div> @@ -2740,12 +2938,16 @@ <p> If generating diffs, detect and report renames for each commit. For following files across renames while traversing history, see - <tt>--follow</tt>. - If <tt>n</tt> is specified, it is a threshold on the similarity + <code>--follow</code>. + If <code>n</code> is specified, it is a threshold on the similarity index (i.e. amount of addition/deletions compared to the - file’s size). For example, <tt>-M90%</tt> means git should consider a + file’s size). For example, <code>-M90%</code> means git should consider a delete/add pair to be a rename if more than 90% of the file - hasn’t changed. + hasn’t changed. Without a <code>%</code> sign, the number is to be read as + a fraction, with a decimal point before it. I.e., <code>-M5</code> becomes + 0.5, and is thus the same as <code>-M50%</code>. Similarly, <code>-M05</code> is + the same as <code>-M5%</code>. To limit detection to exact renames, use + <code>-M100%</code>. </p> </dd> <dt class="hdlist1"> @@ -2756,8 +2958,8 @@ </dt> <dd> <p> - Detect copies as well as renames. See also <tt>--find-copies-harder</tt>. - If <tt>n</tt> is specified, it has the same meaning as for <tt>-M<n></tt>. + Detect copies as well as renames. See also <code>--find-copies-harder</code>. + If <code>n</code> is specified, it has the same meaning as for <code>-M<n></code>. </p> </dd> <dt class="hdlist1"> @@ -2765,13 +2967,13 @@ </dt> <dd> <p> - For performance reasons, by default, <tt>-C</tt> option finds copies only + For performance reasons, by default, <code>-C</code> option finds copies only if the original file of the copy was modified in the same changeset. This flag makes the command inspect unmodified files as candidates for the source of copy. This is a very expensive operation for large projects, so use it with caution. Giving more than one - <tt>-C</tt> option has the same effect. + <code>-C</code> option has the same effect. </p> </dd> <dt class="hdlist1"> @@ -2783,14 +2985,14 @@ <dd> <p> Omit the preimage for deletes, i.e. print only the header but not - the diff between the preimage and <tt>/dev/null</tt>. The resulting patch - is not meant to be applied with <tt>patch</tt> nor <tt>git apply</tt>; this is + the diff between the preimage and <code>/dev/null</code>. The resulting patch + is not meant to be applied with <code>patch</code> nor <code>git apply</code>; this is solely for people who want to just concentrate on reviewing the text after the change. In addition, the output obviously lack enough information to apply such a patch in reverse, even manually, hence the name of the option. </p> -<div class="paragraph"><p>When used together with <tt>-B</tt>, omit also the preimage in the deletion part +<div class="paragraph"><p>When used together with <code>-B</code>, omit also the preimage in the deletion part of a delete/create pair.</p></div> </dd> <dt class="hdlist1"> @@ -2798,7 +3000,7 @@ </dt> <dd> <p> - The <tt>-M</tt> and <tt>-C</tt> options require O(n^2) processing time where n + The <code>-M</code> and <code>-C</code> options require O(n^2) processing time where n is the number of potential rename/copy targets. This option prevents rename/copy detection from running if the number of rename/copy targets exceeds the specified @@ -2810,13 +3012,13 @@ </dt> <dd> <p> - Select only files that are Added (<tt>A</tt>), Copied (<tt>C</tt>), - Deleted (<tt>D</tt>), Modified (<tt>M</tt>), Renamed (<tt>R</tt>), have their - type (i.e. regular file, symlink, submodule, …) changed (<tt>T</tt>), - are Unmerged (<tt>U</tt>), are - Unknown (<tt>X</tt>), or have had their pairing Broken (<tt>B</tt>). + Select only files that are Added (<code>A</code>), Copied (<code>C</code>), + Deleted (<code>D</code>), Modified (<code>M</code>), Renamed (<code>R</code>), have their + type (i.e. regular file, symlink, submodule, …) changed (<code>T</code>), + are Unmerged (<code>U</code>), are + Unknown (<code>X</code>), or have had their pairing Broken (<code>B</code>). Any combination of the filter characters (including none) can be used. - When <tt>*</tt> (All-or-none) is added to the combination, all + When <code>*</code> (All-or-none) is added to the combination, all paths are selected if there is any file that matches other criteria in the comparison; if there is no file that matches other criteria, nothing is selected. @@ -2847,7 +3049,7 @@ </dt> <dd> <p> - When <tt>-S</tt> or <tt>-G</tt> finds a change, show all the changes in that + When <code>-S</code> or <code>-G</code> finds a change, show all the changes in that changeset, not just the files that contain the change in <string>. </p> @@ -3039,6 +3241,8 @@ <div class="paragraph"><p>For more detailed explanation on these common options, see also <a href="gitdiffcore.html">gitdiffcore(7)</a>.</p></div> </div> +</div> +<div class="sect1"> <h2 id="_generating_patches_with_p">Generating patches with -p</h2> <div class="sectionbody"> <div class="paragraph"><p>When "git-diff-index", "git-diff-tree", or "git-diff-files" are run @@ -3056,12 +3260,12 @@ </p> <div class="literalblock"> <div class="content"> -<pre><tt>diff --git a/file1 b/file2</tt></pre> +<pre><code>diff --git a/file1 b/file2</code></pre> </div></div> -<div class="paragraph"><p>The <tt>a/</tt> and <tt>b/</tt> filenames are the same unless rename/copy is +<div class="paragraph"><p>The <code>a/</code> and <code>b/</code> filenames are the same unless rename/copy is involved. Especially, even for a creation or a deletion, -<tt>/dev/null</tt> is <em>not</em> used in place of the <tt>a/</tt> or <tt>b/</tt> filenames.</p></div> -<div class="paragraph"><p>When rename/copy is involved, <tt>file1</tt> and <tt>file2</tt> show the +<code>/dev/null</code> is <em>not</em> used in place of the <code>a/</code> or <code>b/</code> filenames.</p></div> +<div class="paragraph"><p>When rename/copy is involved, <code>file1</code> and <code>file2</code> show the name of the source file of the rename/copy and the name of the file that rename/copy produces, respectively.</p></div> </li> @@ -3071,7 +3275,7 @@ </p> <div class="literalblock"> <div class="content"> -<pre><tt>old mode <mode> +<pre><code>old mode <mode> new mode <mode> deleted file mode <mode> new file mode <mode> @@ -3081,11 +3285,11 @@ rename to <path> similarity index <number> dissimilarity index <number> -index <hash>..<hash> <mode></tt></pre> +index <hash>..<hash> <mode></code></pre> </div></div> <div class="paragraph"><p>File modes are printed as 6-digit octal numbers including the file type and file permission bits.</p></div> -<div class="paragraph"><p>Path names in extended headers do not include the <tt>a/</tt> and <tt>b/</tt> prefixes.</p></div> +<div class="paragraph"><p>Path names in extended headers do not include the <code>a/</code> and <code>b/</code> prefixes.</p></div> <div class="paragraph"><p>The similarity index is the percentage of unchanged lines, and the dissimilarity index is the percentage of changed lines. It is a rounded down integer, followed by a percent sign. The @@ -3099,33 +3303,35 @@ <li> <p> TAB, LF, double quote and backslash characters in pathnames - are represented as <tt>\t</tt>, <tt>\n</tt>, <tt>\"</tt> and <tt>\\</tt>, respectively. + are represented as <code>\t</code>, <code>\n</code>, <code>\"</code> and <code>\\</code>, respectively. If there is need for such substitution then the whole pathname is put in double quotes. </p> </li> <li> <p> -All the <tt>file1</tt> files in the output refer to files before the - commit, and all the <tt>file2</tt> files refer to files after the commit. +All the <code>file1</code> files in the output refer to files before the + commit, and all the <code>file2</code> files refer to files after the commit. It is incorrect to apply each change to each file sequentially. For example, this patch will swap a and b: </p> <div class="literalblock"> <div class="content"> -<pre><tt>diff --git a/a b/b +<pre><code>diff --git a/a b/b rename from a rename to b diff --git a/b b/a rename from b -rename to a</tt></pre> +rename to a</code></pre> </div></div> </li> </ol></div> </div> +</div> +<div class="sect1"> <h2 id="_combined_diff_format">combined diff format</h2> <div class="sectionbody"> -<div class="paragraph"><p>Any diff-generating command can take the ‘-c` or <tt>--cc</tt> option to +<div class="paragraph"><p>Any diff-generating command can take the ‘-c` or <code>--cc</code> option to produce a <em>combined diff</em> when showing a merge. This is the default format when showing merges with <a href="git-diff.html">git-diff(1)</a> or <a href="git-show.html">git-show(1)</a>. Note also that you can give the `-m’ option to any @@ -3134,7 +3340,7 @@ <div class="paragraph"><p>A <em>combined diff</em> format looks like this:</p></div> <div class="listingblock"> <div class="content"> -<pre><tt>diff --combined describe.c +<pre><code>diff --combined describe.c index fabadb8,cc95eb0..4866510 --- a/describe.c +++ b/describe.c @@ -3160,7 +3366,7 @@ + if (!initialized) { initialized = 1; - for_each_ref(get_name);</tt></pre> + for_each_ref(get_name);</code></pre> </div></div> <div class="olist arabic"><ol class="arabic"> <li> @@ -3170,12 +3376,12 @@ </p> <div class="literalblock"> <div class="content"> -<pre><tt>diff --combined file</tt></pre> +<pre><code>diff --combined file</code></pre> </div></div> <div class="paragraph"><p>or like this (when <em>--cc</em> option is used):</p></div> <div class="literalblock"> <div class="content"> -<pre><tt>diff --cc file</tt></pre> +<pre><code>diff --cc file</code></pre> </div></div> </li> <li> @@ -3185,12 +3391,12 @@ </p> <div class="literalblock"> <div class="content"> -<pre><tt>index <hash>,<hash>..<hash> +<pre><code>index <hash>,<hash>..<hash> mode <mode>,<mode>..<mode> new file mode <mode> -deleted file mode <mode>,<mode></tt></pre> +deleted file mode <mode>,<mode></code></pre> </div></div> -<div class="paragraph"><p>The <tt>mode <mode>,<mode>..<mode></tt> line appears only if at least one of +<div class="paragraph"><p>The <code>mode <mode>,<mode>..<mode></code> line appears only if at least one of the <mode> is different from the rest. Extended headers with information about detected contents movement (renames and copying detection) are designed to work with diff of two @@ -3202,58 +3408,60 @@ </p> <div class="literalblock"> <div class="content"> -<pre><tt>--- a/file -+++ b/file</tt></pre> +<pre><code>--- a/file ++++ b/file</code></pre> </div></div> <div class="paragraph"><p>Similar to two-line header for traditional <em>unified</em> diff -format, <tt>/dev/null</tt> is used to signal created or deleted +format, <code>/dev/null</code> is used to signal created or deleted files.</p></div> </li> <li> <p> Chunk header format is modified to prevent people from - accidentally feeding it to <tt>patch -p1</tt>. Combined diff format + accidentally feeding it to <code>patch -p1</code>. Combined diff format was created for review of merge commit changes, and was not meant for apply. The change is similar to the change in the extended <em>index</em> header: </p> <div class="literalblock"> <div class="content"> -<pre><tt>@@@ <from-file-range> <from-file-range> <to-file-range> @@@</tt></pre> +<pre><code>@@@ <from-file-range> <from-file-range> <to-file-range> @@@</code></pre> </div></div> -<div class="paragraph"><p>There are (number of parents + 1) <tt>@</tt> characters in the chunk +<div class="paragraph"><p>There are (number of parents + 1) <code>@</code> characters in the chunk header for combined diff format.</p></div> </li> </ol></div> <div class="paragraph"><p>Unlike the traditional <em>unified</em> diff format, which shows two -files A and B with a single column that has <tt>-</tt> (minus — appears in A but removed in B), <tt>+</tt> (plus — missing in A but -added to B), or <tt>" "</tt> (space — unchanged) prefix, this format +files A and B with a single column that has <code>-</code> (minus — appears in A but removed in B), <code>+</code> (plus — missing in A but +added to B), or <code>" "</code> (space — unchanged) prefix, this format compares two or more files file1, file2,… with one file X, and shows how X differs from each of fileN. One column for each of fileN is prepended to the output line to note how X’s line is different from it.</p></div> -<div class="paragraph"><p>A <tt>-</tt> character in the column N means that the line appears in -fileN but it does not appear in the result. A <tt>+</tt> character +<div class="paragraph"><p>A <code>-</code> character in the column N means that the line appears in +fileN but it does not appear in the result. A <code>+</code> character in the column N means that the line appears in the result, and fileN does not have that line (in other words, the line was added, from the point of view of that parent).</p></div> <div class="paragraph"><p>In the above example output, the function signature was changed -from both files (hence two <tt>-</tt> removals from both file1 and -file2, plus <tt>++</tt> to mean one line that was added does not appear +from both files (hence two <code>-</code> removals from both file1 and +file2, plus <code>++</code> to mean one line that was added does not appear in either file1 nor file2). Also eight other lines are the same -from file1 but do not appear in file2 (hence prefixed with <tt>+</tt>).</p></div> -<div class="paragraph"><p>When shown by <tt>git diff-tree -c</tt>, it compares the parents of a +from file1 but do not appear in file2 (hence prefixed with <code>+</code>).</p></div> +<div class="paragraph"><p>When shown by <code>git diff-tree -c</code>, it compares the parents of a merge commit with the merge result (i.e. file1..fileN are the -parents). When shown by <tt>git diff-files -c</tt>, it compares the +parents). When shown by <code>git diff-files -c</code>, it compares the two unresolved merge parents with the working tree file (i.e. file1 is stage 2 aka "our version", file2 is stage 3 aka "their version").</p></div> </div> +</div> +<div class="sect1"> <h2 id="_examples">Examples</h2> <div class="sectionbody"> <div class="dlist"><dl> <dt class="hdlist1"> -<tt>git log --no-merges</tt> +<code>git log --no-merges</code> </dt> <dd> <p> @@ -3261,7 +3469,7 @@ </p> </dd> <dt class="hdlist1"> -<tt>git log v2.6.12.. include/scsi drivers/scsi</tt> +<code>git log v2.6.12.. include/scsi drivers/scsi</code> </dt> <dd> <p> @@ -3270,7 +3478,7 @@ </p> </dd> <dt class="hdlist1"> -<tt>git log --since="2 weeks ago" -- gitk</tt> +<code>git log --since="2 weeks ago" -- gitk</code> </dt> <dd> <p> @@ -3280,7 +3488,7 @@ </p> </dd> <dt class="hdlist1"> -<tt>git log --name-status release..test</tt> +<code>git log --name-status release..test</code> </dt> <dd> <p> @@ -3290,7 +3498,7 @@ </p> </dd> <dt class="hdlist1"> -<tt>git log --follow builtin-rev-list.c</tt> +<code>git log --follow builtin-rev-list.c</code> </dt> <dd> <p> @@ -3300,7 +3508,7 @@ </p> </dd> <dt class="hdlist1"> -<tt>git log --branches --not --remotes=origin</tt> +<code>git log --branches --not --remotes=origin</code> </dt> <dd> <p> @@ -3310,7 +3518,7 @@ </p> </dd> <dt class="hdlist1"> -<tt>git log master --not --remotes=*/master</tt> +<code>git log master --not --remotes=*/master</code> </dt> <dd> <p> @@ -3319,7 +3527,7 @@ </p> </dd> <dt class="hdlist1"> -<tt>git log -p -m --first-parent</tt> +<code>git log -p -m --first-parent</code> </dt> <dd> <p> @@ -3331,7 +3539,7 @@ </p> </dd> <dt class="hdlist1"> -<tt>git log -3</tt> +<code>git log -3</code> </dt> <dd> <p> @@ -3340,6 +3548,8 @@ </dd> </dl></div> </div> +</div> +<div class="sect1"> <h2 id="_discussion">Discussion</h2> <div class="sectionbody"> <div class="paragraph"><p>At the core level, git is character encoding agnostic.</p></div> @@ -3381,33 +3591,33 @@ a warning if the commit log message given to it does not look like a valid UTF-8 string, unless you explicitly say your project uses a legacy encoding. The way to say this is to - have i18n.commitencoding in <tt>.git/config</tt> file, like this: + have i18n.commitencoding in <code>.git/config</code> file, like this: </p> <div class="listingblock"> <div class="content"> -<pre><tt>[i18n] - commitencoding = ISO-8859-1</tt></pre> +<pre><code>[i18n] + commitencoding = ISO-8859-1</code></pre> </div></div> <div class="paragraph"><p>Commit objects created with the above setting record the value -of <tt>i18n.commitencoding</tt> in its <tt>encoding</tt> header. This is to +of <code>i18n.commitencoding</code> in its <code>encoding</code> header. This is to help other people who look at them later. Lack of this header implies that the commit log message is encoded in UTF-8.</p></div> </li> <li> <p> <em>git log</em>, <em>git show</em>, <em>git blame</em> and friends look at the - <tt>encoding</tt> header of a commit object, and try to re-code the + <code>encoding</code> header of a commit object, and try to re-code the log message into UTF-8 unless otherwise specified. You can specify the desired output encoding with - <tt>i18n.logoutputencoding</tt> in <tt>.git/config</tt> file, like this: + <code>i18n.logoutputencoding</code> in <code>.git/config</code> file, like this: </p> <div class="listingblock"> <div class="content"> -<pre><tt>[i18n] - logoutputencoding = ISO-8859-1</tt></pre> +<pre><code>[i18n] + logoutputencoding = ISO-8859-1</code></pre> </div></div> <div class="paragraph"><p>If you do not have this configuration variable, the value of -<tt>i18n.commitencoding</tt> is used instead.</p></div> +<code>i18n.commitencoding</code> is used instead.</p></div> </li> </ol></div> <div class="paragraph"><p>Note that we deliberately chose not to re-code the commit log @@ -3415,6 +3625,8 @@ object level, because re-coding to UTF-8 is not necessarily a reversible operation.</p></div> </div> +</div> +<div class="sect1"> <h2 id="_configuration">Configuration</h2> <div class="sectionbody"> <div class="paragraph"><p>See <a href="git-config.html">git-config(1)</a> for core variables and <a href="git-diff.html">git-diff(1)</a> @@ -3425,7 +3637,7 @@ </dt> <dd> <p> - Default for the <tt>--format</tt> option. (See "PRETTY FORMATS" above.) + Default for the <code>--format</code> option. (See "PRETTY FORMATS" above.) Defaults to "medium". </p> </dd> @@ -3435,7 +3647,7 @@ <dd> <p> Encoding to use when displaying logs. (See "Discussion", above.) - Defaults to the value of <tt>i18n.commitEncoding</tt> if set, UTF-8 + Defaults to the value of <code>i18n.commitEncoding</code> if set, UTF-8 otherwise. </p> </dd> @@ -3445,8 +3657,8 @@ <dd> <p> Default format for human-readable dates. (Compare the - <tt>--date</tt> option.) Defaults to "default", which means to write - dates like <tt>Sat May 8 19:35:34 2010 -0500</tt>. + <code>--date</code> option.) Defaults to "default", which means to write + dates like <code>Sat May 8 19:35:34 2010 -0500</code>. </p> </dd> <dt class="hdlist1"> @@ -3454,10 +3666,10 @@ </dt> <dd> <p> - If <tt>false</tt>, <em>git log</em> and related commands will not treat the + If <code>false</code>, <em>git log</em> and related commands will not treat the initial commit as a big creation event. Any root commits in - <tt>git log -p</tt> output would be shown without a diff attached. - The default is <tt>true</tt>. + <code>git log -p</code> output would be shown without a diff attached. + The default is <code>true</code>. </p> </dd> <dt class="hdlist1"> @@ -3473,7 +3685,7 @@ </dt> <dd> <p> - Which refs, in addition to the default set by <tt>core.notesRef</tt> + Which refs, in addition to the default set by <code>core.notesRef</code> or <em>GIT_NOTES_REF</em>, to read notes from when showing commit messages with the <em>log</em> family of commands. See <a href="git-notes.html">git-notes(1)</a>. @@ -3481,17 +3693,20 @@ <div class="paragraph"><p>May be an unabbreviated ref name or a glob and may be specified multiple times. A warning will be issued for refs that do not exist, but a glob that does not match any refs is silently ignored.</p></div> -<div class="paragraph"><p>This setting can be disabled by the <tt>--no-notes</tt> option, +<div class="paragraph"><p>This setting can be disabled by the <code>--no-notes</code> option, overridden by the <em>GIT_NOTES_DISPLAY_REF</em> environment variable, -and overridden by the <tt>--notes=<ref></tt> option.</p></div> +and overridden by the <code>--notes=<ref></code> option.</p></div> </dd> </dl></div> </div> +</div> +<div class="sect1"> <h2 id="_git">GIT</h2> <div class="sectionbody"> <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div> </div> </div> +</div> <div id="footnotes"><hr /></div> <div id="footer"> <div id="footer-text"> 